Sunteți pe pagina 1din 74

EMC Documentum

Content Transformation Services


Version 7.0

Installation Guide

EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com

Copyright 19992012 EMC Corporation. All Rights Reserved.


EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATION MAKES NO REPRESENTATIONS
OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF
Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks
used 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 can
make our documentation better or easier to use, please send us your feedback directly at IIGDocumentationFeedback@emc.com.

Table of Contents

Preface
Chapter 1

Chapter 2

.................................................................................................................................
Installing Content Transformation Services

................................................ 11

Installed components ........................................................................................


Content Transformation Services plug-ins ......................................................

11
12

Pre-installation configuration ............................................................................


Software prerequisites ..................................................................................
Selecting the server host ................................................................................
Documentum Foundation Classes .................................................................
Downloading installers .................................................................................
Setting up a global registry ............................................................................
Verifying the connection broker .....................................................................
Identifying a Connection Broker in dfc.properties .......................................
Checking Connection Broker and repository services ..................................
Setting the locale of the repository and host ....................................................
Installing Microsoft fonts ..............................................................................
Required installation information ..................................................................
Installing Content Transformation Services ........................................................
Installing Content Transformation Services DAR files .....................................
Deleting version 6.0 or earlier DocApps .....................................................
Configuring Headless Composer ...............................................................
Installing a DAR file with DAR Installer Plugin ..........................................
Moving Content Transformation Services DAR contents from
filestore_01 to distributed store ..................................................................
Content Transformation Services installation ..................................................
Configuring an instance of a Content Transformation Services
server ......................................................................................................
Content Transformation Services silent installation and configuration ..............

14
14
15
15
16
16
17
17
18
18
18
18
21
22
22
23
23

Post-installation tasks .......................................................................................


Enabling a Document Foundation Classes installation to access a
global registry .............................................................................................
Configuring Content Transformation Server for another repository..................
Enhancing memory availability for Content Transformation Services ...............
Configuring separate Content Transformation Services instances to
handle real-time and asynchronous requests ..................................................

31

.............................................
Uninstalling Content Transformation Services ....................................................
Manual uninstallation ...................................................................................
Backing up and removing old profiles........................................................
Viewing log file of migrated profiles ......................................................

Upgrading Content Transformation Services

Removing a Content Transformation Server instance from a


repository ................................................................................................
Uninstalling previous versions of Content Transformation
Services products .....................................................................................
Uninstalling the Content Transformation Services Framework .....................
Silent uninstallation ......................................................................................

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

24
25
27
29

32
32
33
33
35
35
35
36
36
37
37
38
39

Table of Contents

Removing Content Transformation Services repository


configuration settings in the silent mode ....................................................
Uninstalling Content Transformation Services in the silent mode .................
Uninstalling Content Transformation Services ........................................
Uninstalling Content Transformation Services Framework ......................
Uninstalling Documentum Foundation Classes ......................................

39
40
40
41
41

.............................. 43
Verifying Content Transformation Services installation ....................................... 43
Verifying startup of Content Transformation Services service .......................... 43

Chapter 3

Verifying Content Transformation Services Installation

Chapter 4

Integrating a Streaming Server with Content Transformation


Services ......................................................................................................

45

Prerequisites ....................................................................................................

45

Setting up a Streaming Server ............................................................................

46

Chapter 5

Chapter 6

Chapter 7

Setting up streaming storage areas .....................................................................

46

Setting default_storage for the format objects .....................................................


Finding file format names .............................................................................
Windows Media formats ...............................................................................
Real Media formats.......................................................................................
Darwin formats ............................................................................................
Flash formats ...............................................................................................
Ensuring Streaming Server access to storage areas ..............................................

47
47
47
48
48
48
49

Creating mount points or VirtualDirectory .........................................................

49

Setting the storage areas base_url attribute ........................................................

49

Testing the Streaming Server .............................................................................


Real Helix on Windows.................................................................................

50
50

Deploying Content Transformation Services WebServices

......................... 53

Deploying Content Transformation Services WebServices on VMware


vFabric tc Server 2.6.3 .......................................................................................

53

Deploying Content Transformation Services WebServices on Oracle


Weblogic 12c ....................................................................................................

56

Deploying Content Transformation Services WebServices on Apache


Tomcat .............................................................................................................

59

Installation Troubleshooting ........................................................................


Troubleshooting tips for Content Transformation Services ...................................
Checking the version of a Content Transformation Services installer ................
Cannot pass SuperUser and repository user information screen .......................
Checking the installer log file ........................................................................
If cts_instance_info is not created when the Configurator is executed ...............
A Transformation DAR error occurs when upgrading from a
previous version ...........................................................................................
Deleting log files...........................................................................................
Third-party applications installed on the Content Transformation
Services host should not be used by any other products or users......................
Uninstalling or reinstalling Content Transformation Services...........................
Content Transformation Services Configurator does not configure
Japanese, Korean, or Simplified Chinese repository.........................................
Resolving issues with email content containing double byte characters ............
Installing the Language Pack

63
63
64
64
64
64
65
66
66
66
66
67

...................................................................... 69

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Table of Contents

Installing an Content Transformation Services Language Pack .............................

69

Enabling multilingual support in Content Transformation Services ......................

70

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Table of Contents

List of Figures

Figure 1.

Typical Content Transformation Services installation for PDF and HTML


transformation .................................................................................................

12

Figure 2.

Typical Content Transformation Services installation for audio, video,


and image transformation .................................................................................

12

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Table of Contents

List of Tables

Table 1.

Transformation Services .......................................................................................

Table 2.

Required installation information ..........................................................................

18

Table 3.

Description of DAR Installer Fields (Content Transformation Services DAR) ............

24

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

14

Table of Contents

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Preface

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

What is Content Transformation Services?


Content Transformation Services is a Documentum server-side product that performs transformations
and analysis on repository content. The Content Transformation Services functionality is available
through Documentum client applications.
Content Transformation Services provides the following functionalities:
Transformations
Content Transformation Services converts Microsoft Word and PowerPoint files into PDF and
HTML formats. In addition, you can apply watermarks, PDF overlays, headers, and footers to
transformed PDF documents. Rich Media files are transformed into low resolution versions
that do not monopolize network bandwidth and are ideal for review of general content and
layout. Channel requirements are met by modifying frame rate, bit rate, resolution and encoding
characteristics of audio and video files.
Metadata Analysis and Attribution
Content Transformation Services extracts attributes from content. Examples of extracted attributes
are height and width of image files, and author and subject of documents. The extracted attributes
are stored as metadata or rendition attributes. Some rendition attributes can be mapped to
object-level attributes.
Enhanced Content Previews
Content Transformation Services generates thumbnails and storyboards to enhance the
previewing experience of PDF documents, images, PowerPoint presentations, and video files
that are present in the repository.
Rendition Management
Content Transformation Services stores different formats of a repository file as renditions or
related objects. Renditions are alternate formats of content that share the same object attributes
and security. Related objects are complete objects on their own with independent metadata
and security.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Preface

The EMC Documentum Content Transformation Services Administration Guide describes the functionality
of Content Transformation Services in detail.

Intended audience
This guide is intended for the person who installs and configures Content Transformation Services,
often called the system administrator or system operator.
It is assumed that the system operator has a basic understanding of the Windows operating system.

Revision history
The following changes have been made to this document.
Revision Date

Description

November 2012

Initial publication

10

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Chapter 1
Installing Content Transformation
Services

This chapter describes the process of installing Content Transformation Services on a Windows host.
Post-installation tasks, configuration tasks, and troubleshooting information are also provided in
this document.
Installed components, page 11
Pre-installation configuration, page 14
Installing Content Transformation Services, page 21
Post-installation tasks, page 31
Content Transformation Services allows for a high level of scalability. Content Transformation
Services runs under the Windows Service on the Content Transformation Services host.
Each Content Transformation Services instance can be configured for multiple repositories. If you
have one installation of Content Transformation Services on a host, the same installation can be
configured against different repositories.

Installed components
This section describes the architecture of the installed Content Transformation Services.
Content Transformation Services integrates with third-party plug-ins to enable transformation of
objects into renditions.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

11

Installing Content Transformation Services

Figure 1. Typical Content Transformation Services installation for PDF and HTML transformation

Content Transformation Services integrates with streaming servers so that you can view streamed
media from the repository without waiting for the file to download. Thumbnail servers enable
automatic transformation of files into thumbnails or storyboards after they are imported into the
repository.
Figure 2. Typical Content Transformation Services installation for audio, video, and image transformation

Content Transformation Services plug-ins


Plug-ins are extensible. You can configure plug-in types and formats, and you can add new plug-ins
to the system to support new file formats as required.

12

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

The Content Transformation Services plug-ins perform the following functions:


Transform audio and video files. The standard plug-ins for audio and video transformations are:
Video1 Identifies and extracts media-specific properties and generates thumbnails,
storyboards, and low-resolution renditions of objects. In addition, this plug-in facilitates the
conversion of one video format to another.
Video2 Performs closed caption extraction.
Enable users to transform a variety of documents from one format to another (for example, from
DOC to PDF or HTML).
The standard plug-ins for performing document transformations are:
Doc2 Transforms Adobe PDF files into the XML format. This transformation comes into use
while using the xCP Viewer Search feature.
Doc3 Transforms Adobe PostScript files into Adobe PDF files.
Doc4 Supports application of watermarks, overlays, headers, and footers to PDF documents.
Doc5 Supports page-reordering for PDF and TIFF files.
Doc7 Supports mail attachment extraction and storage as related objects.
AdvancedPDF1 Transforms Microsoft Word, Excel, and PowerPoint files into HTML, Adobe
PDF, and Image file formats.
Identify and extract media-specific properties, such as height, width, color mode, and
compression, and generate thumbnails and low-resolution renditions of objects. The plug-ins also
enable the transformation of media files from one format to another (for example, from TIFF to
JPEG) and provide users with the ability to perform transformations such as resizing, flipping,
or rotating an image.
The standard plug-ins for media transformation are:
PowerPoint Generates thumbnails, low-resolution renditions, storyboards, and slide objects
for PowerPoint files.
Image 1 Processes images. Generates thumbnails, generates low-resolution renditions,
extracts properties, and performs transformations such as resize and transformTo.
Image 2 Processes images. Generates thumbnails, generates low-resolution renditions,
extracts properties, and performs transformations such as resize.
Image 3 Processes images and other file formats. Generates thumbnails, generates
low-resolution renditions, and extracts properties of large image files. This plug-in also
generates thumbnails, generates low-resolution renditions, extracts properties, and creates
storyboards for PDF files.
Image 4 Processes images and other file formats.
PDF Storyboard Generates thumbnails, low-resolution renditions, and storyboards for
PDF files.
XMP Extracts metadata from image and document (PDF) formats.
EXIF Extracts EXIF metadata from image files that have embedded EXIF metadata.
All standard plug-ins are installed during the installation of Content Transformation Services.
Some of the standard plug-ins may require prerequisite third-party applications to be installed. For
more information about applications, see Software prerequisites, page 14.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

13

Installing Content Transformation Services

Pre-installation configuration
Ensure that the following requirements are met before you install Content Transformation Services:
Software prerequisites, page 14
Selecting the server host, page 15
Documentum Foundation Classes, page 15
Downloading installers, page 16
Setting up a global registry, page 16
Verifying the connection broker, page 17
Setting the locale of the repository and host, page 18
Installing Microsoft fonts, page 18
Required installation information, page 18

Software prerequisites
This section provides information about the software that is required or optional for Content
Transformation Services.
The following software must be installed, configured, and running properly on your network before
you install Content Transformation Services:
Documentum Content Server
Before installing Content Transformation Services, you must install several applications and other
components on the server host (or another machine, where applicable). Table 1, page 14 provides
details about the software that must be installed, configured, and running properly on the host (or
another machine, whichever applicable) before you install Content Transformation Services.
Table 1. Transformation Services

Supporting Software / Rendering


Applications

Required/
Optional

Notes

Documentum Composer/DAR
Installer

Required

To install DAR files. Does not have to be


installed on the Content Transformation
Services host, but must be able to
access Content Transformation Services
repositories.

Microsoft Windows as the operating


system.

Required

Documentum Administrator

Optional

14

To access Content Transformation


Services administration features.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

Supporting Software / Rendering


Applications

Required/
Optional

Notes

AFPL GhostScript (x64), version 9.05

Optional

Allows the Doc3 plug-in to process


PostScript files.
Allows the Image 3 plug-in to process
PDF, Adobe Illustrator (AI), and
Encapsulated PostScript (EPS) files.

Arial Unicode Font

Optional

To support extended multi byte character


range in documents (Chinese, Japanese,
Korean, Arabic, and so on).

Note: Ensure that all applications are installed in their default location. Content Transformation
Services refers to each applications default installation directory while launching an application.
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 Content Transformation
Services.

Selecting the server host


This section provides basic guidelines for selecting the host machine for your Content Transformation
Services installation.
The server name must not, and cannot exceed 15 bytes (an error message appears during
installation when you attempt to enter a host name that is longer than 15 bytes).
The server must have a 6 GB System RAM (or higher capacity). The Content Transformation Server
requires a 4 GB RAM for file manipulations. In addition, if the expected file size to be processed is
very large then an equivalent memory allowance needs to be provisioned. For example, if the
largest file expected is 1 GB, then the Content Transformation Server requires an extra 1 GB
RAM (4GB + 1GB). Enhancing memory availability for Content Transformation Services, page 33
provides instructions on how you can increase the RAM for Content Transformation Services.
Caution: To ensure optimal system performance, do not install Content Transformation Services
on the same host as the Content Server or the FAST (Full Text Index) Server. This configuration
is not supported.

Documentum Foundation Classes


The Documentum Foundation Classes (DFC) are a set of Java classes that provide access to Content
Server functionality.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

15

Installing Content Transformation Services

Document Foundation Classes must be installed on the Content Transformation Services host, and is
included with each installer. During installation, Content Transformation Services installer checks for
an existing Document Foundation Classes on the host. The following scenarios are possible:
If Document Foundation Classes does not exist on the host, the installer installs the correct version.
If an earlier version of Document Foundation Classes exists on the host, it is replaced by the
version included with the installer. Refer to the EMC Documentum System Upgrade and Migration
Guide for more information on migration issues.
Any applications that were dependent upon an earlier version of Document Foundation Classes
will have to be upgraded as well. For more information on Document Foundation Classes and its
effect on other applications, refer to your specific Documentum application documentation.
If a version of Document Foundation Classes exists and it is newer than that which is included
with the installer, it will be refreshed.

Downloading installers
Before beginning the installation process, it is best to have the installer ready and available
on your Content Transformation Services host. The EMC Software Download Center
https://emc.subscribenet.com provides a complete listing of products is available for download. The
download files for Content Transformation Services is as follows:
Content Transformation Services Installer Zip file (cts_7.0.0000.xxxx.zip)
The zipped file contains the executable installer file (ctsWinSuiteSetup.exe), silent installer
batch files, and configuration files.
Unzip the zipped files into a temporary folder before you proceed with the installation.

Setting up a global registry


When a global registry is enabled, you can deploy service-based objects automatically from the central
repository designated as the global registry, and network locations created in the global registry are
available in distributed configurations. The global registry is enabled during repository configuration.
There is no limit to how many repositories may be configured as global registries; however, you may
need more than one global registry if you have applications that have very different user access levels.
The EMC Documentum Content Server Installation Guide explains the global registry in detail.
If the global registry does not have Content Transformation Services configured against it, then the
transformation and rich_media_services DARs need to be manually run against the global registry.
Enabling a Document Foundation Classes installation to access a global registry , page 32 describes
the procedure to select a global registry after the Content Transformation Installation installation, or
to change the password for the global registry user, or to update the dfc.properties file with a
different global registry than initially configured.

To set up a global registry:


1.

16

Determine which repository will function as the global registry.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

2.

During repository configuration, you are prompted to provide the user login name and
password for the global registry user. By default, the global registry user has the user name
of dm_bof_registry.
The global registry users account is used by Document Foundation Classes clients to connect
to the repository to access required service-based objects or network locations stored in the
global registry. The global registry user has Read access to objects in the /System/Modules and
/System/NetworkLocations only, and no other objects.

3.

When you install Document Foundation Classes on client machines, provide those Document
Foundation Classes installations with the global user login credentials.
This applies to Desktop installations on end-user computers, to Web Development Kit-based
clients such as Webtop on application server host, and to the Document Foundation Classes
instances on Content Server and remote Content Server hosts.

4.

Ensure that the global registry repository projects to connection brokers known to the Document
Foundation Classes instances that must access the global registry. Identifying a Connection
Broker in dfc.properties, page 17 provides instructions.

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 17 provides instructions.
The Connection Broker and repository services are running on your Content Server. Checking
Connection Broker and repository services, page 18 provides more information on this topic.

Identifying a Connection Broker in dfc.properties


If you already have Documentum Foundation Classes installed on the Content Transformation
Services host server, you will have a dfc.properties file. This procedure is to ensure that the
correct Connection Broker is specified. If you are installing Content Transformation Services on
a clean host, you will not have a dfc.properties prior to installation. In such a scenario, the
following procedure is not required.
The EMC Documentum Content Server Administration and Configuration Guide provides more
information 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 the
one that contacts the repository. Change it if necessary.

4.

Save and close the dfc.properties file.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

17

Installing Content Transformation Services

Checking Connection Broker and repository services


The Connection Broker and repository services must be running correctly on the Content Server
host before you install Content Transformation Services. The EMC Documentum Content Server
Administration and Configuration Guide provides more information about the Connection Broker
and 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 the
same before installing Content Transformation Services. If it is not, the cts_instance_info table is
not created in the repository.
Install Content Transformation Services on a server where the locale is set to en and configure 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 Content
Transformation Services server host to get the right target PDF renditions. Otherwise, the original
fonts are replaced with alternate fonts in the resultant PDF rendition.
Note: The Arial Unicode MS font must be installed to support double byte characters.
http://support.microsoft.com/kb/314960 describes the procedure to install and uninstall Microsoft
fonts.

Required installation information


The table in this section allows you to record the information you need to install a Content
Transformation Services server. Having this information ready and available prior to installation
ensures the accuracy and efficiency of your installation.
Table 2. Required installation information

Installation information

Description

Document Foundation Classes


installation directory

This is the destination directory


for Document Foundation
Classes.

Your value

The default directory is C:\Program Files\Documentum.

18

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

Installation information

Description

Document Foundation Classes


user directory

This is where the log files for


Document Foundation Classes
are stored, where exported
documents are stored, and
where checked out documents
are stored. The default
directory is C:\Documentum.

Connection Broker host name

If the correct Document


Foundation Classes has not
yet been installed on the host,
you will be prompted during
installation for the primary
Connection Broker host name
servicing the repository you
want to configure with Content
Transformation Services.

(if not detected)

Content Transformation
Services server installation
directory

Your value

The directory in which


to install the Content
Transformation Services server.
It is recommended that you use
a subdirectory of the directory
in which other Documentum
products are installed.
For example, if
other Documentum
products are installed in
D:\Documentum, install
Content Transformation Server
in D:\Documentum\Content
Transformation Services.
The installer will create the
Content Transformation
Services folder for you.

Content Transformation Server


host
(if not detected)

The name of the machine


on which you are installing
Content Transformation Server.
You may need to enter
this information if it is not
automatically detected by the
installer, or if you are running
the installer from a remote
computer.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

19

Installing Content Transformation Services

Installation information

Description

Admin User name and


password

The name of the admin user


who is installing the Content
Transformation Services server.

Repository SuperUser name


and password

The account the Content


Transformation Server uses to
log in to the repository. Ask
your administrator to supply
you with a SuperUser name
and password.

Notification user name

The name of the user who


will receive notifications from
Content Transformation Server.

Your value

Content Transformation
Services notifies the user of
the results of processing.
For example, if Content
Transformation Server fails to
process a particular item, it
queues an event to the Inbox
of the Content Transformation
Server system operator user
(sysOpUser).
Content Transformation
Services Admin Port

The port used by


Documentum Administrator to
communicate with the Content
Transformation Services
installation. The default is
9095.

Domain name

The name of the domain against


which the user is authenticated.
Use the fully qualified domain.

Global registry

Different Document
Foundation Classes
installations can use different
global registries where required
service-based objects or
network locations are stored. A
single Document Foundation
Classes installation can have
only one global registry. You
will be prompted during
installation for the primary
registry.

dm_bof_registry

By default, the global registry


user has the user name of

20

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

Installation information

Description

Your value

dm_bof_registry. During
repository configuration,
provide the user login name
and password for the global
registry user. The global
registry user should be
someone other than the
administrator.

Installing Content Transformation Services


If you are reinstalling Content Transformation Services , you must first uninstall the previous
version of the product that is installed on your server. Refer to Uninstalling Content Transformation
Services, page 35.
Content Transformation Services installation is accomplished as a four-step process:
1.

Install Content Transformation Services DAR files.


Installing Content Transformation Services DAR files, page 22 describes the process of installing
Content 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 installation, page 25 describes the process of installing
Content Transformation Services using the installer.
Silent Installer
Content Transformation Services silent installation and configuration, page 29 describes 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 Content
Transformation Services server, page 27.

4.

After installing the Content Transformation Services server, you can verify that your installation
is running correctly. Verifying Content Transformation Services installation, page 43 explains
this procedure.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

21

Installing Content Transformation Services

Installing Content Transformation Services DAR files


Install Content Transformation Services DAR files before configuring Content Transformation
Services to obtain all the latest changes/enhancements. Install the DAR files in the global repository
and 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 Composer
and the DAR Installer plug-in on the local machine. Headless Composer is installed as part of
Content Server version 6.5 and later. Headless Composer can be found on the Content Server host at
C:\Documentum\product\<version>\install\composer\ComposerHeadless.
If Content Server is of a version other than 6.5x or later, download and install Headless Composer
before attempting to install the Content Transformation Services DAR files. Headless Composer is
available on the EMC download site as part of Documentum Developer Studio.
Note: You must have Superuser privileges for the repositories in which you are installing the
DAR files.
If you are upgrading from a Content Transformation Services version 6.0 or earlier, delete the existing
version 6.0 or earlier DocApps before installing the DAR files.

Deleting version 6.0 or earlier DocApps


Follow this procedure only if you are upgrading from Content Transformation Services version 6.0
or earlier:

To delete version 6.0 or earlier DocApps:


1.

Log in to a Documentum client (for example, Documentum Administrator, Digital Asset


Manager, and so on) as an administrator user.

2.

Navigate to the \Cabinet\System\Applications folder.

3.

Select the files within the following folders:


CTSTransformRequest
MediaProfile

4.

Select File > Delete.

5.

For each folder, select Delete This folder and All Subfolders and Objects and Delete All
Versions.

6.

Click Finish to apply to all folders.

7.

Click Continue to confirm the deletion.

8.

Check the Applications folder to ensure the folders are deleted.

22

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

Configuring Headless Composer


The Headless Composer zip file has the format DCTM_Headless_Composer_<platform>_<version>.
zip.

To configure headless Composer:


1.

Extract the headless Composer Zip file to a directory of your choice on your local machine. The
directory name must not contain any spaces.

2.

Open the dfc.properties file at: ..\ComposerHeadless\plugins\com.emc.ide.external.dfc_


1.00\documentum.config with a text editor.

3.

Add the Document Foundation Classes and connection broker information, similar to the
following:
dfc.docbroker.host[0]=[DocBroker IP address or host name]

4.

Save your changes and close dfc.properties.

Installing a DAR file with DAR Installer Plugin


Use the DAR Installer Plugin to install a DAR file to a repository if you do not want to use the
interface within Composer. The DAR Installer plugin requires Composer or Headless Composer to
be installed, but does not launch the full Composer IDE. The DAR Installer Plugin is useful in cases
where you want to de-couple the development of DAR files from the installation of DAR files. It is
also useful in situations where installation of DAR files is required as part of a deployment process.
When you open the DAR Installer program, it creates three folders in your Composer installation
directory:
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 occasionally
need 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 other
fields are optional. For a description of the fields for the DAR Installer Utility, see Table 3, page 24.

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. You
can find the DAR Installer Plugin by going to https://emc.subscribenet.com/control/dctm/search
and searching for "Composer to reach the Documentum Composer download site.

2.

Unzip the DAR Installer zip file to the root of your Composer or headless Composer installation
directory.

3.

Run dardeployer.exe, which is located in the Composer root directory, to start the DAR
Installer Plugin.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

23

Installing Content Transformation Services

4.

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

5.

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

6.

In the Repository Details section, specify values for the fields and click Install to install the
DAR file to the repository.
Refer to the Description of DAR Installer Fields table to help guide you through the DAR file
install process.

7.

Repeat steps 24 for the next DAR file.

You can view the log for the DAR installation by selecting the log file from the Log File drop down
menu and clicking Open.
Table 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. The
file path cannot contain any I18N characters or the installation
will fail.

Input File

No

The absolute file path to the install-based parameter file

Local Folder

No

The absolute file path to localized .properties files. If you want to


make your application available in other languages, you need to
localize the project data such as labels, tabs, and descriptions.

Log File

No

The file to save the log to. If this is not specified, the file defaults
to <DAR>.log

Connection
Broker Host

Yes

The address of the Connection Broker

Connection
Broker Port
Repository

Yes

The port of the Connection Broker Repository

Yes

The name of the repository that you want to install the DAR file
to. Click on the Connect button after entering the Docbroker host
and port to retrieve the available repositories.

User Name

Yes

The login name for the repository

Password

Yes

The password for logging into the repository

Domain

No

The domain where the repository resides

Moving Content Transformation Services DAR contents from


filestore_01 to distributed store
When you install DAR files in a distributed environment, by default, the files are installed in the
filestore_01 only. You have to manually move these files currently in filestore_01 to the distributed
store. To do this, run the following DQL statements to move those files:
UPDATE dm_sysobject (ALL) OBJECTS
SET a_storage_type = 'name_of_distributed_store'
WHERE a_storage_type = 'filestore_01'

24

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

name_of_distributed_store represents the name of the distributed storage area you created.

Content Transformation Services installation


Use the installer to provide installation, repository, and global registry information dynamically.
Note: Some screens in the following procedure may not appear during your installation.
Install the product using the Microsoft Desktop Connection client through which the browser
connects to a server on which Microsoft Remote Desktop is enabled.http://windows.microsoft.com/
en-US/windows-vista/Connect-to-another-computer-using-Remote-Desktop-Connection provides
more information about Remote Desktop Connection.
Caution: Document Foundation Classes must be installed in the same location as Content
Transformation Services.

To 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 unzipped Content Transformation Server product
installation files. You must have stored the unzipped files in a temporary folder according to
Downloading installers, page 16.

4.

Double click the ctsWinSuiteSetup.exe file to install the 7.0 version of Content
Transformation Services.
The installer splash screen is displayed, followed by the Welcome screen, which lists the
components 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.
If Document Foundation Classes is already installed on the host server, the installer checks the
version of Document Foundation Classes. If an earlier version of Document Foundation Classes
is detected, it is replaced.

7.

The DFC Runtime Environment Optional Features screen appears. To install the Developer
Documentation select Developer Documentation, and click Next.
The Documentum DFC Runtime Environment Directory for Documentum Software screen
appears.

8.

Change the destination folder for Document Foundation Classes (the default is C:\Program
Files\Documentum\), if required, and then click Next. To accept the default, click Next.
Caution: Document Foundation Classes must be installed in the same location as Content
Transformation Services.
Note: If the correct version of the Document Foundation Classes exists on your system, this
screen does not appear; go to Step 11.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

25

Installing Content Transformation Services

9.

Enter the User Directory for DFC Runtime Environment. This is where exported documents,
checked out documents, and Document Foundation Classes log files are stored. The default
directory is C:\Documentum.
If required, change the user directory for Document Foundation Classes, and then click Next. To
accept the default directory, click Next.
Note: If the correct version of the Document Foundation Classes exists on your system, this
screen does not appear; go to Step 11.

10. Enter a Connection Broker host name (or IP address) and port number.
Type the name of the Connection Broker host name in the Primary Connection Broker Host
Name field and, optionally, type the port number in the Port Number field, and click Next.
Note: If the correct version of the Document Foundation Classes exists on your system, this
screen does not appear; go to Step 11.
11. Identify the Content Transformation Services installation directory (for core components that
Content Transformation Services use). The Installer creates a directory named CTS within the
chosen directory.
It is recommended to accept the default directory (for example, C:\Program
Files\Documentum\CTS), where other Documentum products are installed.
To accept the default directory, click Next.
To choose another directory, click Browse, navigate to the directory, and click Next.
12. Identify the host name of the host machine. This may be detected automatically, if you are
installing directly from the host. Otherwise, enter the network host name.
Click Next.
13. Identify the port number to which the Content Transformation Services Administration Agent
will be configured. This port is used in conjunction with Documentum Administrator to
communicate with Content Transformation Services hosts. The default port number is 9095.
Enter a port number and click Next.
14. Identify 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 already
present on the host.
15. Enter the Admin user name and password; if you are installing for a domain user, use the format
<domain>\<username>.
Caution: It is recommended that you run the Content Transformation Services as a user
other than your actual server admin.
Click Next.
16. The Installation Summary screen appears, listing the applications that will be installed.

26

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

Note: If the correct version of Document Foundation Classes is already installed, the summary
screen will show that Document Foundation Classes is being refreshed.
If you are satisfied with the installation confirmation, click Next.
To change a component of the installation, click Back to navigate back through the Installer
and change the install information.
17. The installation proceeds.
If a message appears advising you that the _jvm directory already exists, click Yes to overwrite
the directory.
18. The installer now migrates all old profiles automatically. A dialog box appears confirming
the following information:
Creation of a pre-migration report of all profiles before they are upgraded.
Confirmation of the beginning of the profile migration process.
Reminder to backup all profiles first, before continuing.
If you have backed up your old profiles, click Next. The installation proceeds.
19. The DFC Global Registry designation screen appears. Identify the global registry repository.
Select Designate the global registry repository to use. Enter the repository name and password.
Select Test Connect, if desired. Click Next.
20. Enter the default global registry user name (dm_bof_registry) and password. This should be
someone other than the administrator. Click Next.
21. A message notifies you that the Content Transformation Server was installed successfully. Click
Finish.
The installation wizard closes.
Note: If you selected to restart your Microsoft Windows system immediately, the system will
restart.

Configuring an instance of a Content Transformation Services


server
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 (including
patch version) to avoid behavior conflicts between versions.
Caution: Make sure the appropriate Connection Broker and repositories are running before
continuing with the configuration.

To configure an instance of Content Transformation Server:


1.

Navigate to the Content Transformation Services Configurator located under Start > Programs >
Documentum > CTS Configuration Utility and click the CTS Configuration Utility.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

27

Installing Content Transformation Services

The Configurator splash screen is displayed, followed by the Welcome screen.


2.

Click Next.
The license agreement terms are displayed.

3.

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

4.

Select Add a Content Transformation Services instance to a docbase, and click Next.
The Configurator stops the Content Transformation Services service.

5.

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

6.

Click Next.
The Enter repository name and user info screen appears.
A list of the repositories served by the Connection Broker appears. For instructions on selecting a
Connection Broker, see Identifying a Connection Broker in dfc.properties, page 17.

7.

Enter information for the repository:


a.

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

b. Enter the performance repository.


Note: This step is not mandatory.
c.

Enter the SuperUser name that Content Transformation Server will use to access the
repository. (Do not use dm_mediaserver.)
Note: In a domain-required repository, you must configure the product with a registered
domain user.

d. Enter the password for the SuperUser account.


e.

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

f.

Enter the name of the repository user who will receive notifications from Content
Transformation Server, otherwise known as the system operator. (Do not use
dm_mediaserver.)
Note: If you are unsure of which users to specify, refer to Required installation information,
page 18 for details regarding values for these fields.

g. If you are not configuring multiple domains, skip this step and proceed to Step 8.
1.

Select the Add Additional Domain Users check box, if you are setting up to support
requests from additional domains. If you have multiple domains in your environment
and you have users in different domains that will be transforming content, select
this option. The installer will create an Admin user for each domain to support
transformations by users of each domain.

2.

Enter credentials for a new domain and its SuperUser in the required fields.

3.

Repeat this step to include additional domains, as required.

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

28

Click Next.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

If you cannot continue, check with the repository administrator to verify that the users exist
and that you entered the correct password.
9.

The User Authentication screen appears. Enter the system administrator name and password;
if you are installing as a domain user, use the format <domain>/<username> in the system
administrator name field. Click Next.
The registry updates.

10. If the repository you have chosen is in a distributed environment, a screen will appear with a
list of Content Servers configured for the repository you have chosen to configure with Content
Transformation Server.
Select a Content Server from the list and select Process local content only.
11. If Content Transformation Services is configured to a repository which has BOCS enabled, an
additional wizard screen displays asking you to select a Network location ID to use from the list
of network locations which the repository supports:
Select the Network Location which has BOCS configured.
Enable the following information fields:
Allow BOCS Transfer
Prefer ACS Transfer
Allow Surrogate Transfer
12. The Configurator now migrates all old profiles automatically, if applicable. A dialog box appears
confirming the following information:
Creation of a pre-migration report of all profiles before they are upgraded.
Confirmation of the beginning of the profile migration process.
Reminder to backup all profiles first before continuing.
If you have backed up your old profiles, select Next. The installation proceeds.
13. A message appears that states "A pre-migration report has been generated and is available at
%CTS_HOME%\migration\log. Click Next. The migration process begins.
Note: If you are not upgrading from a previous version, proceed to the next step.
14. A dialog box indicates the success of the Content Transformation Server configuration.
If you are prompted to restart the host, do so now.
Click Finish. The Configurator closes.

Content Transformation Services silent installation and


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

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

29

Installing Content Transformation Services

Installing Content Transformation Services using the Content Transformation


Services silent installer
1.

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 unzipped Content Transformation Server product
installation files. Downloading installers, page 16 provides information about where the files
should be located.

4.

Configure CTSSilentInstaller.ini with relevant values using a text editor:


[COMMON]
IS_SUITE_INSTALLATION=TRUE
ECI_SERVICES_ASK=FALSE
USER_ACCOUNT=Administrator
#If no domain populate with <HOST_NAME>
USER_DOMAIN=<DOMAIN>
DCTM_PROGRAM_DIR=C:\Program Files\Documentum
DCTM_LOCATION=C:\PROGRAM FILES\DOCUMENTUM
DCTM_USER_DIR=C:\DOCUMENTUM
SETUP_FILES_FOLDER=C:\Program Files\Documentum\setup
BUNDLED_JAVA_HOME=C:\PROGRAM FILES\DOCUMENTUM\java\1.6.0_31
[DFC_BUILD]
YEAR=2011
[DFC]
DOCUMENTATION_FEATURE=FALSE
DOCBROKER_HOST=<DOCBROKER_HOST>
DOCBROKER_PORT=1489
DFC_BOF_GLOBAL_REGISTRY_OPTION_IS_SELECTED=TRUE
DFC_BOF_GLOBAL_REGISTRY_REPOSITORY=<GLOBAL REGISTRY NAME>
DFC_BOF_GLOBAL_REGISTRY_USERNAME=<GLOBAL REGISTRY USER USERNAME>
SECURE.DFC_BOF_GLOBAL_REGISTRY_PASSWORD=<GLOBAL REGISTRY USER PASSWORD>
DFC_BOF_GLOBAL_REGISTRY_VALIDATE_OPTION_IS_SELECTED=TRUE
[CTS]
DISPLAY_VERSION=CTS $P($P(beanId).key.version.major).$P($P(beanId).key.version.minor)
PARENT_DIR=C:\PROGRAM FILES\DOCUMENTUM\CTS
HOSTNAME=<HOSTNAME>
ADMIN_PORT=9095
JETTY_PORT=9096
JDK_DIR=C:\PROGRAM FILES\DOCUMENTUM\java\1.6.0_31
CACHE_DIR=C:\Program Files\Documentum\CTS\cache
LOG4J_LOGS_DIR=C:\Program Files\Documentum
ALTERCAST_PARENT_DIR=C:\Program Files\Documentum\CTS\AlterCast

5.

Configure CTSSilentConfigurator.ini with relevant values using a text editor:


[COMMON]
#If no domain populate with <HOST NAME>
USER_DOMAIN=<DOMAIN>
[CTS]
PARENT_DIR=C:\PROGRAM FILES\DOCUMENTUM\CTS
JDK_DIR=C:\Program Files\Documentum\java\1.6.0_31
AGENTURL=http://<HOST NAME>:9095/CTSAgent/CTSAgent
JETTY_PORT=http://<HOST NAME>:9096/cts/
PARENT_DIR=C:\PROGRAM FILES\DOCUMENTUM\CTS
HOSTNAME=<HOST NAME>
DOCBASE=<DOCBASE>

30

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

DOCBASE_USER=<DOCBASE_USER>
NOT_ENCRYPTED_PASSWORD=<DOCBASE_PWD>
DOMAIN=
DOCBASE_SUPERUSER=<DOCBASE_SUPERUSER>
#CTS machine user details to create CTS Services.
#If user logged into domain, SYS_ADMIN_NAME should contain <Domain>\<Username>
SYS_ADMIN_NAME=<ADMIN_NAME>
SYS_ADMIN_PASS=<ADMIN_PASS>
#BOCS related settings
# To configure BOCS change SKIP_BOCS=NO and set all the required parameters.
SKIP_BOCS=Yes
#BOCS_SELECTED=<dm_network_location_map object_name>
#allowBocsTransfer=<true | false>
#preferAcsTransfer=<true | false>
#allowSurrogateTransfer=<true | false>
#Distributed enviromnent settings.
#SERVER_CONFIG_NAME=<dm_server_config object_name>
#PROCESS_LOCAL_CONTENT_ONLY=<YES | NO>
[MTS]
CONFIGURATOR_DIR=C:\PROGRAM FILES\DOCUMENTUM\CTS\server_install
INSTALL_TYPE=add

6.

Run the run_CTS_silent_installer.bat file.


Microsoft Windows Task Manager console reflects ctsWinSuiteSetup.exe as a running task.

7.

Copy the CTSSilentConfigurator.ini and run_CTS_silent_configurator.bat files


to the %CTS_HOME%\server_install folder location.
Note: The %CTS_HOME% refers to C:\Program Files\Documentum\CTS unless changed
during the prior installation process.

8.

After the ctsWinSuiteSetup.exe task stops running (Microsoft Windows Task


Manager console reflects whether ctsWinSuiteSetup.exe is running or not), run the
run_CTS_silent_configurator.bat file (which exists in the %CTS_HOME%\server_install
folder location).

Post-installation tasks
After installing Content Transformation Services, perform the following configurations, if required:
Enabling a Document Foundation Classes installation to access a global registry , page 32
describes the process to configure the Document Foundation Classes installation to access a
global registry, if you did not select a global registry during the installation, or if the password
for the global registry user has changed, or if you are updating the dfc.properties file with a
different global registry than initially configured.
Configuring Content Transformation Server for another repository, page 32 describes the process
to add more than one Content Transformation Server configurations to your system.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

31

Installing Content Transformation Services

Enhancing memory availability for Content Transformation Services, page 33 describes the
process to increase the memory availability of Content Transformation Services.
Configuring separate Content Transformation Services instances to handle real-time and
asynchronous requests, page 33 describes the process to configure Content Transformation
Services to handle real-time and asynchronous requests

Enabling a Document Foundation Classes installation


to 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 registry


repository:
1.

On the Document Foundation Classes host, navigate to $DOCUMENTUM/config (Linux) or


%DOCUMENTUM%\config (Windows).

2.

From a command prompt, execute the following command to generate the encrypted form of
the global registry users password:
java -cp dfc.jar com.documentum.fc.tools.RegistryPasswordUtils password_of_user

where password_of_user is the global registry users clear-text password. In step 4 below, you will
need 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.jar or
execute the command from a location where dfc.jar is present (for example, C:\PROGRA~1
\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>
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 another


repository
Run one installation of Content Transformation Services on a single host, and configure it against
multiple repositories.
The procedure for adding an instance of Content Transformation Services is exactly the same as the
procedure for the initial configuration of the product for a repository. This procedure does not
perform the base installation or install configuration files, which must be done only once. You do
not need to rerun the entire installation procedure to apply Content Transformation Services to an
additional repository.

32

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing Content Transformation Services

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

Enhancing memory availability for Content


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

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

2.

Select Windows > 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\ControlSet001\services\DocumentumCTS\Parameters].
Modify the value of AppParameters.

6.

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

7.

Close the registry.

8.

Restart Content Transformation Services through the Windows Services Utility.

Configuring separate Content Transformation Services


instances to handle real-time and asynchronous
requests
For improving the performance of Content Transformation Services while handling both
asynchronous requests and real-time requests, you must have dedicated Content Transformation
Services instances for handling each kind of requests. If there are two Content Transformation
Services instances, for example,"CTS_Realtime and "CTS_Async, and you need to configure them
to handle real-time and asynchronous requests only, do the following:
1.

The "CTS_Realtime instance should be tuned to not ping the queue and not pick up any of
the queue items.
a.

Login to the "CTS_Realtime machine and navigate to the %CTS%\config folder.

b. Open the CTSServerService.xml file in a text editor.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

33

Installing Content Transformation Services

c.

Comment out the full <QueueProcessorContext> sections, where queueItemName="dm_


mediaserver for all of the repositories that are configured with "CTS_Realtime instance.
There will be one <QueueProcessorContext> for one repository.

d. Update the other <QueueProcessorContext> > and rename the queueItemName


"dm_autorender_win31" to "dm_autorender_win31_do_not_ping" for all of the repositories
that are configured with "CTS_Realtime instance.
e.
2.

Save the file and restart Content Transformation Services.

The applications sending real-time requests to Content Transformation Services need to be


configured such that the requests do not go into "CTS_Async.
a.

Login to the Application Server machine hosting your application.

b. Navigate to the Content Transformation Services preferences.xml and open it


in a text editor.
c.

Use this configuration element to specify a list of semicolon separated Content Transformation
Services instances.
ServerProperty Key="CTS_SkipList" Description="list of cts instances
(semicolon separated) to skip (scalability)" Value="CTS_Async;
<other-cts-instances>"/>

Note: Use the hostname as it appears in cts_instance_info table. To retrieve the hostname,
run the "Select hostname from cts_instance_info DQL.
The EMC Documentum Content Server Administration and Configuration Guide provides details
on the above configuration element "CTS_SkipList.
With these changes, "CTS_Realtime will not pick up any of the queue items and will be dedicated
only for the real-time requests. The "CTS_Async will not receive any of the real-time requests and
will process only the queue items. This approach can be scaled up and applied to configure multiple
Content Transformation Services instances for handling either real-time or asynchronous requests.

34

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Chapter 2
Upgrading Content Transformation
Services

Previous versions of Content Transformation Services consisted of transformation components


such as Document Transformation Services, Advanced Document Transformation Services, Media
Transformation Services, and Audio Video Transformation Services. However, this version of
Content Transformation Services encapsulates the functionality of all transformation components
and requires just one installation, rather than multiple installation processes for multiple Content
Transformation Services components.
To install Content Transformation Services, uninstall previous versions of Content Transformation
Services components. If you are installing Content Transformation Services the first time, skip to
Chapter 1, Installing Content Transformation Services.

Uninstalling Content Transformation Services


This section provides information to uninstall Content Transformation Services. Uninstallation of
Content Transformation Services can be performed in the following ways:
Manual uninstallation, page 35
Silent uninstallation, page 39

Manual uninstallation
The following steps comprise the manual uninstallation process for Content Transformation Services:
1.

Backing up and removing old profiles, page 36

2.

Removing a Content Transformation Server instance from a repository, page 37

3.

Uninstalling previous versions of Content Transformation Services products, page 37

4.

Uninstalling the Content Transformation Services Framework, page 38

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

35

Upgrading Content Transformation Services

Backing up and removing old profiles


If you have customized or added any profiles on a repository that were previously configured with
Content Transformation Services, these profiles are migrated automatically during installation and
configuration of this version of the product. However, it is strongly recommended that all profiles be
backed up manually prior to installing this version of Content Transformation Services. Export a
copy of all profiles to a local disk before making any changes to your product installations.
It is also recommended, but not mandatory, to remove old profiles from the repository before
installing this version. This ensures that only the current profiles included with this version of
Content Transformation Services are contained within the Media 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 the
Media Server folder to a local disk.

3.

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

Viewing log file of migrated profiles


During installation of Content Transformation Services, a dialog box appears with the following
information:
Creation of a pre-migration report of all profiles before they are upgraded.
Confirmation of the beginning of the profile migration process.
Reminder to backup all profiles first before continuing.
You can view the log file generated by the profile migration tool. This log file shows the profiles
that were processed, their status, and the profiles that were not migrated and the reason why
they were not migrated. The default location of the log file of migrated profiles is C:\Program
Files\Documentum\Content Transformation Services\migration\log.
The migration log file shows the result of the migration process:
migration_log_2007_292_1192813617312.txt ->
Migration log;

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

36

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Upgrading Content Transformation Services

Removing a Content Transformation Server instance from a


repository
This section describes how to remove an instance of Content Transformation Services from a
repository. This procedure does not remove the configuration files and services associated with the
Content Transformation Server. Uninstalling the Content Transformation Services Framework, page
38 describes the process to remove Content Transformation Server from a host.

To remove an instance of Content Transformation Server from a repository:


1.

Navigate to Content Transformation Services Configurator under Start > Programs >
Documentum > CTS Configuration Utility.
Note: If you have an instance of a version prior to this version of Content Transformation
Services, you must navigate to Start > Programs > Documentum > <Content Transformation
Services product> Configuration Utility.
The Content Transformation Services Configurator splash screen is displayed, followed by
the Welcome 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 Server instance from a docbase 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.

7.

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

8.

Click Finish 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 previous versions of Content Transformation Services


products
This section describes steps to uninstall the previous and current version of Content Transformation
Services.
All instances of Content Transformation Services deployed against a repository must share the same
version (including patch version) to avoid behavior conflicts between versions. Therefore, before you
install a new version of Content Transformation Services, you must uninstall any previous version of
Content Transformation Services or Content Transformation Services products.
Depending on whether you have installed this version or a previous version of Content
Transformation Services, you must uninstall Content Transformation Services in a relevant sequence.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

37

Upgrading Content Transformation Services

If you have installed a previous version of a Content Transformation Services product, uninstall
the product in the following order:
1.

Uninstall Documentum <Content Transformation Services product>.

2.

Uninstall Documentum Content Transformation Services.

If you have installed the 7.0 version of Content Transformation Services, you must uninstall the
product in the following order:
1.

Uninstall Documentum Content Transformation Services.

2.

Uninstall Documentum Content Transformation Services Framework.

Uninstalling Content Transformation Services:


1.

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

2.

Perform one of the following steps in the Add or Remove Programs window:
Select <Documentum Content Transformation Services product> if you are uninstalling an
earlier version, and click Change/Remove.
If you are uninstalling this version of Content Transformation Services, select Documentum
Content Transformation Services, and then click Change/Remove.

3.

In the Change/Remove dialog box, click Next.

4.

Follow the steps in the Uninstall Wizard.

Uninstalling the Content Transformation Services Framework


Perform the following procedure to uninstall Documentum Content Transformation Services
Framework from your host server.

To uninstall the Content Transformation Services Framework:


1.

Log in as an Administrator user to the machine on which Content Transformation Services is


installed.

2.

Ensure that no program or application is running.

3.

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

4.

Select Documentum Content Transformation Services Framework and click Change/Remove.


Note: For earlier versions of Content Transformation Services, you must select Documentum
Content Transformation Services, and then click Change/Remove.
The uninstaller welcome screen appears.

5.

Click Next.

6.

The location from which Content Transformation Services will be removed is displayed. Click
Next.
The Content Transformation Services service stops and Content Transformation Services
Framework is uninstalled.

38

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Upgrading Content Transformation Services

7.

Restart the computer when you are prompted. All files that have been in use are deleted. This is
important if you are reinstalling Content Transformation Services on the host.

8.

Delete the log4j.properties file from the Content Transformation Services installation
folder location.

Silent uninstallation
If you want to run the silent unconfiguration and uninstallation utilities to remove Content
Transformation Services from the server, perform the following steps:
1.

Backing up and removing old profiles, page 36

2.

Removing Content Transformation Services repository configuration settings in the silent mode,
page 39

3.

Uninstalling Content Transformation Services in the silent mode, page 40

Note: This procedure is applicable only to Content Transformation Services, version 6.7 and later.

Removing Content Transformation Services repository


configuration settings in the silent mode
Perform the following procedure if you want to remove Content Transformation Services using the
silent configurator. The silent unconfigurator allows you to provide installation, repository, and
global registry information in a configuration file, after which you can run the configurator batch
files. 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.

Navigate to %CTS_HOME%\server_install and configure CTSSilentConfigurator.ini with


relevant values using a text editor, and insert remove as the value of INSTALL TYPE:
[COMMON]
#If no domain populate with <HOST_NAME>
USER_DOMAIN=<DOMAIN>
[CTS]
PARENT_DIR=C:\PROGRAM FILES\DOCUMENTUM\CTS
JDK_DIR=C:\Program Files\Documentum\java\1.6.0_31
AGENTURL=http://<HOST_NAME>:9095/CTSAgent/CTSAgent
JETTY_PORT=http://<HOST_NAME>:9096/cts/
SERVER_CONFIG_NAME=<HOST_NAME>
PARENT_DIR=C:\PROGRAM FILES\DOCUMENTUM\CTS
HOSTNAME=<HOST_NAME>
DOCBASE=<DOCBASE_NAME>
DOCBASE_USER=<DOCBASE_USER>
NOT_ENCRYPTED_PASSWORD=<DOCBASE_PWD>
DOMAIN=
DOCBASE_SUPERUSER=<DOCBASE_SUPERUSER>
SYS_ADMIN_NAME=<ADMIN_NAME>
SYS_ADMIN_PASS=<ADMIN_PASS>
SKIP_BOCS=Yes

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

39

Upgrading Content Transformation Services

[MTS]
CONFIGURATOR_DIR=C:\PROGRAM FILES\DOCUMENTUM\CTS\server_install
INSTALL_TYPE=remove

4.

Run run_CTS_silent_configurator.bat.

Uninstalling Content Transformation Services in the silent mode


Perform the following procedure to uninstall Content Transformation Services using the Content
Transformation Services silent uninstaller. The silent installer allows you to provide installation,
repository, and global registry information in a configuration file, after which you can run the
configurator batch files. The batch files run silently in the background.
Caution: Ensure that you have unconfigured Content Transformation Services before you
uninstall Content Transformation Services. Removing Content Transformation Services
repository configuration settings in the silent mode, page 39 describes the procedure for silent
unconfiguration of Content Transformation Services.
Uninstalling Content Transformation Services is a three-step process:
1.

Uninstalling Content Transformation Services, page 40

2.

Uninstalling Content Transformation Services Framework, page 41

3.

Uninstalling Documentum Foundation Classes, page 41

Uninstalling Content Transformation Services


You must run the uninstallation commands from the command prompt:
1.

Open the Windows Command Prompt.

2.

Navigate to C:\Program Files\Documentum\_uninst\mts.


Note: If you are uninstalling a Content Transformation Services version prior to the 7.0 version,
navigate to C:\Program Files\Documentum\_uninst\<Content Transformation
Services product>.

3.

Execute the following command to uninstall Content Transformation Services:


start

/wait MtsUninstaller.exe -silent

Note: If you are uninstalling a Content Transformation Services product version prior to the 7.0
version, execute the following command to uninstall Content Transformation Services:
start

/wait <Content Transformation Services product>Uninstaller.exe -silent

The control is not returned to user until the command is fully executed.
Note: If the uninstallation fails, the contents of the mts folder are not deleted and uninstallation
log files appear.
4.

40

Restart the server host.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Upgrading Content Transformation Services

Uninstalling Content Transformation Services Framework


You must run the uninstallation commands from the command prompt:
1.

Open the Windows Command Prompt.

2.

Navigate to C:\Program Files\Documentum\_uninst\cts.

3.

Execute the following command to uninstall Content Transformation Services:


start

/wait CtsUninstaller.exe -silent

The control is not returned to user until the command is fully executed.
Note: If the uninstallation fails, the contents of the cts folder are not deleted and uninstallation
log files appear.
4.

Restart the server host.

Uninstalling Documentum Foundation Classes


You must run the uninstallation commands from the command prompt:
1.

Open the Windows Command Prompt.

2.

Navigate to C:\Program Files\Documentum\_uninst\dfc.

3.

If LaunchUninstaller.bat exists in the folder, then execute the following command to


uninstall the DFC Runtime Environment:
start /wait LaunchUninstaller.bat -silent

If the LaunchUninstaller.bat file is not available, then use the uninstall.exe file.
Note: If the uninstallation fails, the contents of the dfc folder are not deleted and uninstallation
log files appear.
4.

Restart the server host.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

41

Upgrading Content Transformation Services

42

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Chapter 3
Verifying Content Transformation
Services Installation

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


This chapter contains the following sections:
Verifying Content Transformation Services installation, page 43

Verifying Content Transformation Services


installation
This section describes how to verify that you have successfully installed Content Transformation
Services. There are two ways to verify the installation:
Check that the Windows Content Transformation Services service has started, and that this service
is present on the repository.
Import a test file to the repository.
Both tests are recommended. This will ensure your installation is working correctly.

Verifying startup of Content Transformation Services


service
Once Content Transformation Server is installed and configured for a repository, Content
Transformation 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.

Select Windows > Administrative Tools > Services to access the Windows Services utility.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

43

Verifying Content Transformation Services Installation

3.

44

Ensure that Documentum Content Transformation Services is started.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Chapter 4
Integrating a Streaming Server with
Content Transformation Services

This chapter describes how to integrate a Streaming Server with Content Transformation Services and
Content Server. It also provides an example of how to test the Streaming Server integration.
Supported streaming file format families depend upon the Streaming Server(s) that you integrate
with Content Transformation Services.
The following topics and tasks are included in this chapter:
Prerequisites, page 45
Setting up a Streaming Server, page 46
Setting up streaming storage areas, page 46
Setting default_storage for the format objects, page 47
Ensuring Streaming Server access to storage areas, page 49
Creating mount points or VirtualDirectory, page 49
Setting the storage areas base_url attribute, page 49
Testing the Streaming Server, page 50

Prerequisites
Content Transformation Services does not include a Streaming Server. Streaming Server requirements
must be followed as per the documentation for those products. Content Transformation Services
is agnostic regarding streaming video servers and does not explicitly certify specific products or
versions. Streaming Servers must be purchased from their vendors.
Before integrating one or more Streaming Servers, they should be installed on their own host, where
possible. The Streaming Server should not be installed on the Content Server host. In many cases, the
intensive operations of the Streaming Server may degrade the performance of the Content Server.
There may be some exceptions to this, such as Windows Media Server. Please see your streaming
server product documentation for further detail.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

45

Integrating a Streaming Server with Content Transformation Services

Setting up a Streaming Server


To integrate a Streaming Server with Content Server, complete the following steps.

To integrate a Streaming Server:


1.

Create a second dm_filestore object to store Windows Media streaming formats, if applicable.
Setting up streaming storage areas, page 46 provides detailed information.

2.

Set the default_storage attribute in the streaming format objects to the streaming storage area, as
described in Setting default_storage for the format objects, page 47.

3.

Ensure that the Streaming Server has access to the storage area. Follow the instructions in
Ensuring Streaming Server access to storage areas, page 49.

4.

Create a mount point (or a VirtualDirectory for Adobe Flash Media Server) on the Streaming
Server for the storage area, as described in Creating mount points or VirtualDirectory, page 49.

5.

Set the base_url attribute for the storage area. Setting the storage areas base_url attribute, page
49 provides detailed information.

6.

Restart the Streaming Server.

7.

If using Windows Media Server, it should be initialized at least once prior to using with Content
Transformation Services.

Setting up streaming storage areas


Each Streaming Server may support different file formats. To use two Streaming Servers, you require
a second streaming storage area. The files handled by each server must be stored in separate areas.
This means that in addition to the default store (streaming_store_01), you must create another
streaming store (for example, streaming_store_02).
Note: It is important that you set the media_type to 2 in the dm_filestore object.
For more information on creating storage areas, refer to the Storage Management chapter in the EMC
Documentum Content Server Administration and Configuration Guide.

To create a second streaming storage area:


1.

See the instructions provided in the EMC Documentum Content Server Administration and
Configuration Guide to create a dm_location object. Using DQL statements, your setup should
appear similar to the following:
create dm_location object
set object_name = streaming_storage_02',
set path_type = directory',
set file_system_path =
C:\DOCUMENTUM\data\<repository>\streaming_storage_02',
set mount_point_name = '
go

46

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Integrating a Streaming Server with Content Transformation Services

2.

See the instructions provided in the EMC Documentum Content Server Administration and
Configuration Guide to create a dm_filestore object. Ensure that you set the media_type to 2. Using
DQL statements, your setup should appear similar to the following:
create dm_filestore object
set name = streaming_store_02',
set root = streaming_storage_02',
set is_public = true,
set require_ticket = false
set media_type = 2
go

Setting default_storage for the format objects


The default_storage attribute is used by the Documentum client to identify the storage location for
content. For streaming content, you must set the attribute to the object ID of the streaming content
storage area.
Only Digital Asset Manager and Web Publisher use the default_storage setting in format objects. If a
user saves a document with streaming content using any other Documentum client, the content is
saved to the default storage area for the object type.
Note: File formats supported by each server may change or differ from those listed below. Consult
your Streaming Server documentation for the current list of supported file formats.

Finding file format names


In the following DQL statements for setting the default_storage for format objects, file formats are
entered, not file extensions. File format names can be found by running the following DQL statement:
select * from dm_format where dos_extension = 'extension'

For example, the following DQL statement will find the name of the mov extension:
select * from dm_format where dos_extension = 'mov'

The result of the mov query will be one record, where quicktime is the proper format name for the
mov extension:
r_object_id

name

description

dos_extension

2701e306800001bf

quicktime

QuickTime Movie

mov

Windows Media formats


Even if you are using Real Helix Universal server exclusively, you must also identify a separate
storage area for Windows Media file formats. Use the following DQL statement to update the formats
recognized by the Windows Media storage area:
UPDATE dm_format OBJECTS
SET default_storage=(SELECT r_object_id FROM dm_filestore

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

47

Integrating a Streaming Server with Content Transformation Services

where name ='<storage_area_name>')


WHERE name in (<format_name>', <format_name>')

For example, if the Windows Media file formats are to be stored in streaming_store_01, the statement
should appear as follows:
UPDATE dm_format OBJECTS
SET default_storage=(SELECT r_object_id FROM dm_filestore
WHERE name ='streaming_store_01')
WHERE name in (wmv', wma', wmx', wax', asf')

Real Media formats


Use the following DQL statement to update the formats recognized by the Real Media storage area:
UPDATE dm_format OBJECTS
SET default_storage=(SELECT r_object_id FROM dm_filestore
WHERE name ='<storage_area_name>')
WHERE name in (<format_name>', <format_name>')

For example, if the Real Helix server formats are to be stored in streaming_store_02:
UPDATE dm_format OBJECTS
SET default_storage=(SELECT r_object_id FROM dm_filestore
WHERE name ='streaming_store_02')
WHERE name in (ra', ram', rm', rmm', rnx', rv', quicktime')

Darwin formats
Use the following DQL statement to update the formats recognized by the Real Media storage area:
UPDATE dm_format OBJECTS
SET default_storage=(SELECT r_object_id FROM dm_filestore
WHERE name ='<storage_area_name>')
WHERE name in (<format_name>', <format_name>')

For example, if the Darwin formats are to be stored in streaming_store_03:


UPDATE dm_format OBJECTS
SET default_storage=(SELECT r_object_id FROM dm_filestore
WHERE name ='streaming_store_03')
WHERE name in (quicktime')

Flash formats
Use the following DQL statement to update the formats recognized by the Adobe Flash Media
Server storage area:
UPDATE dm_format OBJECTS
SET default_storage=(SELECT r_object_id FROM dm_filestore
WHERE name ='<storage_area_name>')
WHERE name in (<format_name>', <format_name>')

For example, if the Flash formats are to be stored in streaming_store_04:


UPDATE dm_format OBJECTS

48

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Integrating a Streaming Server with Content Transformation Services

SET default_storage=(SELECT r_object_id FROM dm_filestore


WHERE name ='streaming_store_04')
WHERE name in (flv', f4v')

Ensuring Streaming Server access to storage


areas
On a Windows host, the Streaming Server must run under the System account or as the Documentum
Content Server installation owner, to ensure access to the streaming content storage areas.

Creating mount points or VirtualDirectory


You must create a mount point (or a VirtualDirectory for Adobe Flash Media Server) on the Streaming
Server that points to the root of the streaming storage area. The root path is the value found in the
file_system_path attribute of the location object associated with the storage area. To obtain that
value, execute the following DQL statement:
SELECT file_system_path FROM dm_location a, dm_filestore f WHERE f.name=
'<storage_area_name>' AND a.object_name=f.root

Substitute the storage areas name for storage_area_name.


The returned value is a full root path specification for the storage areas location.
Use your Streaming Servers product documentation for instructions on how to create a mount
point or virtual directory.

Setting the storage areas base_url attribute


For the Documentum client to retrieve a file from a streaming storage area, Content Server must
provide the URL for the content file. The Content Server then sends that URL to the Streaming Server.
The base of the URL returned by Content Server is defined in the base_url attribute of the streaming
storage areas storage object. This attribute must be set manually for streaming content storage areas.
Refer to the documentation accompanying the Streaming Server to determine the base URL.
Note: For all base_url paths, you must include the ending forward slash (/).
For Windows Media Server:
on its own, it is typically similar to:
mms://<host_name>/mountpoint1/

For Real Helix Universal Server, the base_url is typically similar to:
Real file formats
rtsp://<host_name>:<port>/mountpoint1/

Windows file formats (if you are not using Windows Media Server as well)

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

49

Integrating a Streaming Server with Content Transformation Services

http://<host_name>:<port>/mountpoint2/

For Darwin Streaming Server:


the base_url is typically similar to:
rtsp://<host_name>/

For Adobe Flash Media Server:


the base_url is typically similar to:
rtmp://<host_name>/vod/mp4:<VirtualDirectory>/

To set the storage areas base_url attribute:


For Windows Media Server:
Use the following DQL statement to set the base_url attribute:
UPDATE dm_filestore object
set base_url='mms://<machine name>/mountpoint1/'
where name = 'storage_area_name'

For Real Helix Universal Server:


Use the following DQL statement to set the base_url attribute:
UPDATE dm_filestore object
set base_url='rtsp://<machine name>:<port number>
/mount_point_name/'
where name = 'storage_area_name'

For Darwin:
Use the following DQL statement to set the base_url attribute:
UPDATE dm_filestore object
set base_url='rtsp://<machine name>/'
where name = 'storage_area_name'

For Adobe Flash Media Server:


Use the following DQL statement to set the base_url attribute:
UPDATE dm_filestore object
set base_url='rtmp://<host_name>/vod/mp4:<VirtualDirectory>/'
where name = 'storage_area_name'

Testing the Streaming Server


When you are finished integrating the Streaming Server with Content Server and Content
Transformation Services, it is important that you test the Streaming Servers functionality.
You can test the configuration of your Streaming Server through IAPI calls.

Real Helix on Windows


The following example shows a test session for Real Helix Universal Server on Windows.

50

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Integrating a Streaming Server with Content Transformation Services

To test the Real Helix server on Windows:


1.

Enter the text in bold, when prompted:


/iapi32
Please enter a repository name (docubase) : dmtestdb
Please enter a user (Documentum): <user>
Please enter password for Documentum :<password>
Documentum iapi - Interactive API interface
(c) Copyright Documentum, Inc., 1992-2001
All rights reserved.
Client Library Release 5.1.0.64 Win32
Connecting to Server using repository dmtestdb
[DM_SESSION_I_SESSION_START]info: "Session
011e9a8b80040107 started
for user Documentum."
Connected to Documentum Server running Release
5.1.0.64 Win32.Oracle
Session id is s0
API> create,c,dm_document
...
091e9a8b80037d00
API> set,c,l,object_name
SET> Streaming test
...
OK
API> set,c,l,a_storage_type
SET> streaming_store_01
...
OK
API> setfile,c,l,C:\Program Files\Real\RealServer\
Content\real8video.rm,rm
...
OK
API> save,c,l
...
OK
API> apply,c,l,GET_FILE_URL,FORMAT,S,rm
...
q0
API> next,c,q0
...
OK
API> dump,c,q0
...
USER ATTRIBUTES
result : T
base_url: rtsp://eng178:554/mountpoint1/
store : streaming_store_01
path : 001e9a8b\80\00\00\42.rm
ticket :
SYSTEM ATTRIBUTES
APPLICATION ATTRIBUTES
INTERNAL ATTRIBUTES
API> close,c,q0
...
OK

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

51

Integrating a Streaming Server with Content Transformation Services

API>

2.

Concatenate the value for base_url and path (for example, rtsp://eng178:554/mountpoint1/
001e9a8b\80\00\00\42.rm) and paste the string into the Real Player.
The video represented by the URL will begin to stream.

52

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Chapter 5
Deploying Content Transformation
Services WebServices

Content Transformation Services WebServices is based on Documentum Foundation Services


platform. It provides synchronous realtime transformation capabilities. Any client application based
on Content Transformation Services WebServices may request transformations that result in files that
are available directly to the client, with minimal turn around time.
Content Transformation Services WebServices is deployed using an EAR.
The following topics are covered in this chapter:
Deploying Content Transformation Services WebServices on VMware vFabric tc Server 2.6.3,
page 53
Deploying Content Transformation Services WebServices on Oracle Weblogic 12c, page 56
Deploying Content Transformation Services WebServices on Apache Tomcat, page 59

Deploying Content Transformation Services


WebServices on VMware vFabric tc Server 2.6.3
Content Transformation Services WebServices is deployed using a transformation.war file. Use the
following procedure to deploy and configure the transformation.war for tcServer.
1.

Install the tcServer on a Windows host.

2.

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

3.

Stop the server instance from services if it is already running.

4.

Create a folder with the name "cts_ws at your working directory (Consider C:\Documentum
as your working directory).
a.

Create the following subfolders inside cts_ws folder.


\cache
\config
\logs

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

53

Deploying Content Transformation Services WebServices

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 in
the 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 firewall
restriction" 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 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 at
C:\Program Files\Documentum\CTS\config) and paste it to C:\Documentum\cts_ws\config
on the Content Transformation Services WebServices/tcServer host.

8.

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

9.

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

10. Copy and paste the exploded transformation folder to the "webapps folder of a tc Server
instance. For example, C:\tc-server-standard-2.6.3\myserver\webapps.
a.

Update the dfc.properties file under WEB-INF\classes to correct details for


docbroker (Connection Broker), global registry details, and so on. This file is located at
C:\tc-server-standard-2.6.3\myserver\webapps \transformation\WEB-INF\classes).
It will typically appear like the following:
dfc.data.checkout_dir=${dfc.data.user_dir}/checkout
dfc.data.dir=C:\Documentum\data
dfc.data.export_dir=${dfc.data.user_dir}/export
dfc.data.user_dir=${dfc.data.dir}
dfc.exception.include_decoration=false
dfc.exception.include_id=false

54

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Deploying Content Transformation Services WebServices

dfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==
dfc.globalregistry.repository=CSFPI33_GR
dfc.globalregistry.username=dm_bof_registry
dfc.search.ecis.enable=false
dfc.search.ecis.host=
dfc.search.ecis.port=
dfc.tokenstorage.dir=${dfc.data.user_dir}/apptoken
dfc.tokenstorage.enable=false
dfc.docbroker.host[0]=10.31.107.145
dfc.docbroker.port[0]=1489

b. Update the log4j.properties file under WEB-INF\classes to point to the right location
for all log files. Properties which should be modified are given in bold.
log4j.rootCategory=WARN, A1, F1
log4j.category.MUTE=OFF
log4j.additivity.tracing=false
log4j.category.tracing=DEBUG, FILE_TRACE
#---------------------------- CONSOLE ---------------------------106 EMC Documentum Content Transformation Services Version 7.0 Installation Guide
Deploying CTS WebServices
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.threshold=ERROR
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n
#---------------------------- FILE ---------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppender
log4j.appender.F1.File=C:/Documentum/cts_ws/logs/log4j.log
log4j.appender.F1.MaxFileSize=10MB
log4j.appender.F1.layout=org.apache.log4j.PatternLayout
log4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n
#---------------------------- FILE_TRACE ---------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE_TRACE.File=C:/Documentum/cts_ws/logs/trace.log
log4j.appender.FILE_TRACE.MaxFileSize=100MB
log4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %20c{1} %m%n
#---------------------------- CTSWS ---------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppender
log4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppender
log4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.CTSWSAppender.File=C:/Documentum/cts_ws/logs/CTSWS_log.txt
log4j.appender.CTSWSAppender.Append=true
log4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p %20c
{1} %m%n
log4j.appender.CTSWSAppender.DatePattern='.'yyyyMMdd
#---------------------------- DFS ---------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppender
log4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.DFSAppender.File=C:/Documentum/cts_ws/logs/DFS_log.txt
log4j.appender.DFSAppender.Append=true
log4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p [%t]
%20c{1} %5x %m%n
log4j.appender.DFSAppender.DatePattern='.'yyyyMMdd

11. Update the transformation.properties file in WEB-INF\classes to have the correct path to
the preferences.xml file.
It will typically appear like the following:
#cts ws preferences config location

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

55

Deploying Content Transformation Services WebServices

CTSWSConfig=C:/Documentum/cts_ws/config/preferences.xml

12. Start the tcServer instance.


13. Ensure that TransformationService and ProfileService are accessible from the tcServer host and
a 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 the
Content Transformation Services WebServices server.

Deploying Content Transformation Services


WebServices on Oracle Weblogic 12c
Content Transformation Services WebServices is deployed using a transformation.ear file. Use the
following procedure to deploy and configure the transformation.ear for a Oracle Weblogic 12c
application server.
Note: To deploy Content Transformation Services Webservices on Weblogic Server 12c, Oracle patch
13603813 must be installed on the host where Weblogic Server 12c is installed.

To deploy Content Transformation Services WebServices on Windows with Oracle


Weblogic 12c:
1.

Install the Oracle Weblogic 12c Server and create a new weblogic domain (for example, "ws) as
per the WebLogic Installation Guide.

2.

After the domain creation is complete, all files related to the domain (for example, "ws) are
available under C:\Oracle\Middleware\user_projects\domains\ws (if WebLogic is installed
in C:\Oracle).

3.

Create a folder with name "cts_ws at your working directory (Consider C:\Documentum as
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).

56

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Deploying Content Transformation Services WebServices

4.

Open a text editor and create a preferences.xml file with the following content and save it in
the directory %WorkingDir%\cts_ws\config.
Note: 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 firewall
restriction" 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 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 at
C:\Program Files\Documentum\CTS\config) and paste it to C:\Documentum\cts_ws\config
on the Content Transformation Services WebServices/WebLogic host.

6.

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

7.

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


a.

Update the dfc.properties file under APP-INF\classes. Enter your docbroker, global
registry details, user name, and password.
It will typically appear like the following:
dfc.data.checkout_dir=${dfc.data.user_dir}/checkout
dfc.data.dir=C:\Documentum\data
dfc.data.export_dir=${dfc.data.user_dir}/export
dfc.data.user_dir=${dfc.data.dir}
dfc.exception.include_decoration=false
dfc.exception.include_id=false
dfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==
dfc.globalregistry.repository=CSFPI33_GR
dfc.globalregistry.username=dm_bof_registry
dfc.search.ecis.enable=false
dfc.search.ecis.host=
dfc.search.ecis.port=
dfc.tokenstorage.dir=${dfc.data.user_dir}/apptoken

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

57

Deploying Content Transformation Services WebServices

dfc.tokenstorage.enable=false
dfc.docbroker.host[0]=10.31.107.145
dfc.docbroker.port[0]=1489

b. Update the log4j.properties file under APP-INF\classes to point the right location for
all log files. Properties which should be modified are given in bold.
log4j.rootCategory=WARN, A1, F1
log4j.category.MUTE=OFF
log4j.additivity.tracing=false
log4j.category.tracing=DEBUG, FILE_TRACE
#------------------- CONSOLE -------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.threshold=ERROR
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %-20c{1} - %m%n
#------------------- FILE -------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppender
log4j.appender.F1.File=C:/Documentum/cts_ws/logs/log4j.log
log4j.appender.F1.MaxFileSize=10MB
log4j.appender.F1.layout=org.apache.log4j.PatternLayout
log4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %-20c{1} - %m%n
#------------------- FILE_TRACE -------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE_TRACE.File=C:/Documentum/cts_ws/logs/trace.log
log4j.appender.FILE_TRACE.MaxFileSize=100MB
log4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %-20c{1}
- %m%n
#------------------- CTSWS -------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppender
log4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppender
log4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.CTSWSAppender.File=C:/Documentum/cts_ws/logs/CTSWS_log.txt
log4j.appender.CTSWSAppender.Append=true
log4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p
%-20c{1} %m%n
log4j.appender.CTSWSAppender.DatePattern='.'yyyy-MM-dd
#------------------- DFS -------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppender
log4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.DFSAppender.File=C:/Documentum/cts_ws/logs/DFS_log.txt
log4j.appender.DFSAppender.Append=true
log4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p [%t]
%-20c{1} - %5x %m%n
log4j.appender.DFSAppender.DatePattern='.'yyyy-MM-dd

8.

Update this transformation.properties from the transformation.ear (available under


APP-INF\classes) file to have the correct preferences.xml location for CTSWSConfig property.
Typically, the WebLogic workspace for the domain is C:\bea\user_projects\domains\ws.
#cts ws preferences config location
CTSWSConfig=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 in
C:\bea\user_projects\domains\ws\.
OR

58

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Deploying Content Transformation Services WebServices

b. Perform the following steps to deploy the transformation.ear using the WebLogic admin
console:
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 Servicing
all requests from the Start menu.
Ensure the state of the transformation application is "Active.
10. Start "startWebLogic.cmd from the domain "ws (C:\Oracle\Middleware\user_
projects\domains\ws). This will automatically deploy the transformation.ear file.
11. Ensure that the TransformationService and ProfileService are accessible from the WebLogic host
and 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 the
Content Transformation Services WebServices server.

Deploying Content Transformation Services


WebServices on Apache Tomcat
Content Transformation Services WebServices is deployed using a transformation.war file. Use the
following procedure to deploy and configure the transformation.war for Apache Tomcat.

To deploy Content Transformation Services WebServices on Windows with Tomcat:


1.

Install Tomcat on a Windows host.

2.

Stop the Tomcat server.

3.

Create a folder with the name "cts_ws at your working directory (Consider C:\Documentum
as your working directory).

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

59

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


4.

Open a text editor and create a preferences.xml file with the following content and save it in
the directory %WorkingDir%\cts_ws\config.
Note: 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 firewall
restriction" 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 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.keyfile from the Content Transformation Services Server machine (located at
C:\Program Files\Documentum\CTS\config) and paste it to C:\Documentum\cts_ws\config
on the Content Transformation Services WebServices/Tomcat host.

6.

Copy the mspassword.txtfrom the Content Transformation Services Server machine


(located at C:\Program Files\Documentum\CTS\docbases\<docbase_name>\config\pfile)
and paste it to C:\Documentum\cts_ws\config\pfile on the Content Transformation Services
WebServices/Tomcat host.

7.

Explode the contents of the transformation.warfile to a folder named "transformation.

8.

Copy and paste the exploded transformation folder to the "webapps folder of a Tomcat
server configuration. For example, C:\Program Files\Apache Software Foundation\Tomcat
6.0\webapps.

60

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Deploying Content Transformation Services WebServices

a.

Update the dfc.propertiesfile under WEB-INF\classes to correct details for docbroker


(Connection Broker), global registry details, and so on. (located at C:\Program Files\Apache
Software Foundation\Tomcat 6.0\webapps\transformation\WEB-INF\classes).
It will typically appear like the following:
dfc.data.checkout_dir=${dfc.data.user_dir}/checkout
dfc.data.dir=C:\Documentum\data
dfc.data.export_dir=${dfc.data.user_dir}/export
dfc.data.user_dir=${dfc.data.dir}
dfc.exception.include_decoration=false
dfc.exception.include_id=false
dfc.globalregistry.password=YiYQgefRI63JTWDokb7HJQ==
dfc.globalregistry.repository=CSFPI33_GR
dfc.globalregistry.username=dm_bof_registry
dfc.search.ecis.enable=false
dfc.search.ecis.host=
dfc.search.ecis.port=
dfc.tokenstorage.dir=${dfc.data.user_dir}/apptoken
dfc.tokenstorage.enable=false
dfc.docbroker.host[0]=10.31.107.145
dfc.docbroker.port[0]=1489

b. Update the log4j.propertiesfile under WEB-INF\classes to point to the right location


for all log files. Properties which should be modified are given in bold.
log4j.rootCategory=WARN, A1, F1
log4j.category.MUTE=OFF
log4j.additivity.tracing=false
log4j.category.tracing=DEBUG, FILE_TRACE
#---------------------------- CONSOLE ---------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.threshold=ERROR
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n
#---------------------------- FILE ---------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppender
log4j.appender.F1.File=C:/Documentum/cts_ws/logs/log4j.log
log4j.appender.F1.MaxFileSize=10MB
log4j.appender.F1.layout=org.apache.log4j.PatternLayout
log4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %20c{1} %m%n
#---------------------------- FILE_TRACE ---------------------------log4j.appender.FILE_TRACE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE_TRACE.File=C:/Documentum/cts_ws/logs/trace.log
log4j.appender.FILE_TRACE.MaxFileSize=100MB
log4j.appender.FILE_TRACE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE_TRACE.layout.ConversionPattern=%d{ABSOLUTE} [%t] %20c{1} %m%n
#---------------------------- CTSWS ---------------------------log4j.category.com.emc.documentum.fs.services.transformation=DEBUG, CTSWSAppender
log4j.category.com.emc.documentum.cts=DEBUG, CTSWSAppender
log4j.appender.CTSWSAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.CTSWSAppender.File=C:/Documentum/cts_ws/logs/CTSWS_log.txt
log4j.appender.CTSWSAppender.Append=true
log4j.appender.CTSWSAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.CTSWSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p %20c
{1} %m%n
log4j.appender.CTSWSAppender.DatePattern='.'yyyyMMdd
#---------------------------- DFS ---------------------------log4j.category.com.emc.documentum.fs=DEBUG, DFSAppender
log4j.appender.DFSAppender=org.apache.log4j.DailyRollingFileAppender
log4j.appender.DFSAppender.File=C:/Documentum/cts_ws/logs/DFS_log.txt
log4j.appender.DFSAppender.Append=true
log4j.appender.DFSAppender.layout=org.apache.log4j.PatternLayout
log4j.appender.DFSAppender.layout.ConversionPattern=%d{HH\:mm\:ss,SSS} %5p [%t]

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

61

Deploying Content Transformation Services WebServices

%20c{1} %5x %m%n


log4j.appender.DFSAppender.DatePattern='.'yyyyMMdd

9.

Update the transformation.properties file in WEB-INF\classes to have the correct path


to the preferences.xml file.
It will typically appear like the following:
#cts ws preferences config location
CTSWSConfig=C:/Documentum/cts_ws/config/preferences.xml

10. Start the Tomcat server.


11. Ensure TransformationService and ProfileService are accessible from the Tomcat host and a client
machine 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
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 the
Content Transformation Services WebServices server.

62

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Chapter 6
Installation Troubleshooting

This chapter provides information on troubleshooting Content Transformation Services installation.


In addition, consult the EMC Documentum Content Transformation Services Administration Guide for
additional information regarding items that can affect configuration and usability.
This chapter contains the following sections:
Troubleshooting tips for Content Transformation Services, page 63

Troubleshooting tips for Content


Transformation Services
The following troubleshooting tips and topics are for Content Transformation Services.
Checking the version of a Content Transformation Services installer, page 64
Cannot pass SuperUser and repository user information screen, page 64
Checking the installer log file, page 64
If cts_instance_info is not created when the Configurator is executed, page 64
A Transformation DAR error occurs when upgrading from a previous version, page 65
Deleting log files, page 66
Third-party applications installed on the Content Transformation Services host should not be
used by any other products or users, page 66
Uninstalling or reinstalling Content Transformation Services, page 66
Content Transformation Services Configurator does not configure Japanese, Korean, or Simplified
Chinese repository, page 66
Resolving issues with email content containing double byte characters, page 67

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

63

Installation Troubleshooting

Checking the version of a Content Transformation


Services installer
To check the version of a Content Transformation Services installer:
1.

Navigate to the directory where the installer exists.

2.

Open a command prompt window.

3.

Run the following command, using the full path to the Java executable on the machine, if it
is not defined as a system variable:
java -cp <installer_jar_file> DiShowVersion

For example, the full command is: java -cp ctsWinSuiteSetup.jar DiShowVersion.
This displays the full installer version.

Cannot pass SuperUser and repository user information


screen
When you configure Content Transformation Services, you must provide the name and password for
a repository SuperUser to allow the product to access the repository. You must also provide the name
of the repository user who will receive notifications from Content Transformation Services.
If the user information you provide is incorrect, you will not be able to configure Content
Transformation Services. Contact the repository administrator to verify that the SuperUser exists, that
you are using the appropriate password, and that the notification user exists.

Checking the installer log file


If you receive notification that the Content Transformation Server installation has failed, check the
Installer log file. By default, the log file (installer.log) is located in the Content Transformation
Server installation directory identified in Step 11 of the section Content Transformation Services
installation, page 25.

If cts_instance_info is not created when the


Configurator is executed
If the cts_instance_info type is not created when the Configurator is executed, there may be a problem
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/create
statement 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 object

64

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installation Troubleshooting

is not a valid locale in the docbase. the alter/create is


disallowed because it contains locale sensitive information for
an invalid locale. please either set the session_locale to a
valid dd_locales value ('en'), or add a new locale entry to
dd_locales (dm_docbase_config)."

The locale setting for the server and for the repository should match. If, for example, the server
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 machine running the Configurator to match the locale of
the repository, or add the Configurator machines locale to the repository. The locale setting can be
changed using DQL.

A Transformation DAR error occurs when upgrading


from a previous version
As part of an upgrade from a previous version, the Transformation.dar installation may fail with an
error 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: The
procedure '%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 about
what exactly caused it to fail.
In such cases, you may need to manually clean up the repository of Content Transformation
Services-related items by following the steps below:
1.

Navigate to the System cabinet.

2.

In the Media Server folder, Back up any custom profiles.

3.

Delete the Media Server folder (including all versions and sub folders).

4.

Navigate to the System\Applications folder.

5.

Delete the CTSTransformRequest, MediaProfile, and Transformation folders if present


(including all versions and sub folders).

6.

Navigate to the System\Modules\TBO folder

7.

Delete all of the following folders (if present):


dm_Content Transformation Services_response
dm_media_profile
dm_transform_request

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

65

Installation Troubleshooting

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

Deleting log files


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

Third-party applications installed on the Content


Transformation Services host should not be used by
any other products or users
Do not use any application that is installed on the Content Transformation Services host for any other
uses other than Content Transformation Services.
If these applications are being used for some purpose other than by the Content Transformation
Server, there is a possibility of errors or failures in processing.

Uninstalling or reinstalling Content Transformation


Services
Whenever you uninstall Content Transformation Services, ensure that you 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.

Content Transformation Services Configurator does


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

66

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installation Troubleshooting

The problem is that the Japanese, Korean, or Simplified Chinese repository must be populated first
with the English locale (data dictionary). Then the repository should be configured again using
Content Transformation Services Configurator.
To populate the Japanese, Korean, or Simplified Chinese repository with the English locale, perform
the 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 with


Japanese/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 must
be known to the docbase; either the local machine must have the locale of "ko" or the server must
add "en" as an acceptable locale in its local table.

Resolving issues with email content containing double


byte characters
When you import emails with double byte characters in the subject, content, and attachment names, it
is seen that in the subject and attachment names, the double byte characters are corrupted and appear
as "???. For the renditions to be created without character corruption, it is recommended that you
install Arial Unicode MS font on the Content Transformation Services server machine.

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

67

Installation Troubleshooting

68

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Chapter 7
Installing the Language Pack

Content Transformation Services customers who want to implement language packs have to install
the Content Transformation Services Language Pack. The Content Transformation Services Language
Pack includes the transformation profiles and mapping XML file that are included with Content
Transformation Services. Chapter 1, Installing Content Transformation Services provides information
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 69
Enabling multilingual support in Content Transformation Services, page 70

Installing an Content Transformation Services


Language Pack
Content Transformation Services customers who have installed the English Content Transformation
Services product have to install the Content Transformation Services Language Pack to be able
to use language packs. This section describes how to install language packs, and specifies which
components 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 14 for the English product.

2.

Download the required language pack (CTS_Language_Pack_<LanguageName>_<ext>_<EXT>_7.


0.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 Download Center
to a temporary directory on your Content Transformation Services host. If you cannot locate your
password for the download site, use the password finder on the bottom of the download page.
Use your email address as your user name.

3.

Unzip CTS_Language_Pack_<LanguageName>_<ext>_<EXT>_7.0.xxxx.xxxx.zip, which contains


the following folders and files:
mappings
profiles
CTS_Language_Pack_Version_File_<LanguageName>.txt

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

69

Installing the Language Pack

4.

Stop all instances of Content Transformation Services connected to the repository you are
updating 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>_7.0.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\Media


Server\Resources\<LanguageCode_CountryCode>.

6.

Import the file CTS_mappings.xml from CTS_Language_Pack_<LanguageName>_<ext>_


<EXT>_7.0.xxxx.xxxx\mappings folder into the appropriately named \System\Media
Server\Resources\<LanguageCode_CountryCode>\mappings folder created in the previous
step.

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

2.

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

Note: Before using Content Transformation Services language packs, complete Enabling multilingual
support in Content Transformation Services, page 70.

Enabling multilingual support in Content


Transformation Services
Multilingual support can be enabled for Content Transformation Services by installing the Arial
Unicode MS font on each Content Transformation Services machine in order to display different
languages correctly.

70

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Installing the Language Pack

This is a simple procedure that is performed through the Windows Control Panel. Once installed, any
language should be displayed properly (provided that the operating system supports the characters
specific 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 Version 7.0 Installation Guide

71

Installing the Language Pack

72

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

Index

A
admin user, 20
architecture, 11
<at least one index entry>, 35
attributes, 47

scalability, 32
uninstalling, 38
CTS DAR
installing, 22
cts_instance_info, 64

configuring
Global registry, 16
configuring an instance, 27
configuring Streaming Server, 47, 49 to 50
connection broker
verifying, 17
Connection Broker
checking services, 18
host, 19
identifying in dfc.properties, 17
Content Server, 15
Connection Broker, 18
installation prerequisite, 14
integrating Streaming Servers, 45
repositories, 18
setting up storage areas, 46
Content Transformation Server
adding an instance, 32
configuring, 27
installation log file, 64
installing, 18
notifications, 20
pre-installation verifications, 17
removing instances, 37
software prerequisites, 14
verifying installation, 43
Content Transformation Services, 11
description, 9
error messages, 20
expanding, 32
installation directory, 19
integrating Streaming Servers, 45
plug-ins, 12

DAR
installing, 22
default_storage, 47
DFC
about, 15
and dfc.properties, 17
directories, 18
installing, 16
migrating, 16
dfc.properties
identifying a Connection Broker, 17
Documentum Administrator
installation prerequisite, 14
Documentum Foundation Classes. See DFC
domain name, 20

E
expanding Content Transformation
Services, 32

F
failed installation, 64
FAST Server, 15
Full Text Index Server, 15

G
Global registry, 16, 20
about, 16
enabling, 32
set up, 16
user name, 21

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

73

Index

headless Composer, configure, 23


headless Composer, install, 14, 23
host, 19
preparing, 14
selecting, 15

removing an instance, 37
repository, 37
checking, 18
SuperUser, 20
user, 20
repository user, 64
requirements
installation, 18
software, 14

I
installation
directory, 18 to 19
failure, 64
prerequisites, 14 to 15
verifying, 43
installers
downloading, 16
installing, 22
supporting software, 14
instance
adding, 32
configuring, 27
removing, 37

S
scalability
of Content Transformation Services, 32
selecting host, 15
setting up Streaming Server, 46
software prerequisites, 14
startup, verifying, 43
storage areas
setting up for Streaming Servers, 46
Streaming Server, 47, 49 to 50
integration, 45
integration prerequisites, 45
setting up storage areas, 46
setup procedure, 46
SuperUser, 20, 28
SuperUser information, 64

L
locale setting, 64
log file, 64

M
U

migrating profiles, 36
migration of DFC, 16
Migration utility
log file, 36

uninstalling
Content Transformation Services, 38
user
admin, 20
repository, 20

P
plug-ins
Content Transformation Services, 12
prerequisites, 13 to 14
port for CTS Admin, 20
prerequisites
Content Server, 14
Documentum Administrator, 14
third-party applications, 14
profiles
removing, 36
profiles, backing up, 36
profiles, migrating, 36

V
verification
connection broker, 17
verifications
pre-installation, 17
verifying
installation, 43
startup, 43

W
Windows Service, 43

74

EMC Documentum Content Transformation Services Version 7.0 Installation Guide

S-ar putea să vă placă și