Advanced Document Transformation Services Installation Guide

Advanced Document Transformation Services Installation Guide
EMC® Documentum®
Advanced Document Transformation
Services
Version 6.5
Installation Guide
P/N 300­007­270 A02
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748‑9103
1‑508‑435‑1000
www.EMC.com
Copyright © 2006 ‑ 2008 EMC Corporation. All rights reserved.
Published October 2008
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS
OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up‑to‑date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their respective owners.
Table of Contents
Preface
Chapter 1
Chapter 2
Chapter 3
...........................................................................................................................
7
Advanced Document Transformation Services Overview ...................... 9
What is Content Transformation Services? ..................................................... 9
Content Transformation Services scalability ............................................. 10
What is Advanced Document Transformation Services? ................................
Advanced Document Transformation Services components .......................
Advanced Document Transformation Services environment ..................
Advanced Document Transformation Server ........................................
Documentum Foundation Classes .......................................................
Advanced Document Transformation Services plug‑ins ........................
How Advanced Document Transformation Services works .......................
How Advanced Document Transformation Services creates
PDF renditions ...................................................................................
How Advanced Document Transformation Services creates
HTML renditions................................................................................
11
11
11
12
12
13
14
Features of Advanced Document Transformation Services ............................
Capabilities of Advanced Document Transformation Services .......................
16
18
Supported transformations by source and target formats ..............................
Rendering applications for supported source formats ...................................
19
20
Working with the CTS Activity Template ....................................................
Confirming migration of profiles dialog box .................................................
22
22
Getting Started ......................................................................................
Selecting the server host ..............................................................................
Installation prerequisites .............................................................................
Software prerequisites ............................................................................
Uninstalling older versions of Documentum Transformation
Software ................................................................................................
Setup verifications ..................................................................................
Identifying a Connection Broker in dfc.properties .................................
Checking Connection Broker and repository services ............................
25
25
26
26
Installing Advanced Document Transformation Services ......................
Pre‑installation steps ...................................................................................
Backup all profiles ..................................................................................
Remove old profiles ................................................................................
Downloading installers ...........................................................................
Uninstalling previous versions of Documentum Transformation
Software ................................................................................................
Confirming Print Spooler service .............................................................
Preparing the Advanced Document Transformation Services host..............
Installing rendering software applications ....................................................
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
14
15
27
27
27
28
29
29
29
30
30
31
31
32
33
3
Table of Contents
Installing and configuring Advanced Document Transformation
Server ........................................................................................................
Advanced Document Transformation Services installation
overview ................................................................................................
Required Advanced Document Transformation Server
installation information...........................................................................
Installing Advanced Document Transformation Server .............................
Configuring an instance of Advanced Document
Transformation Server ............................................................................
Enabling a DFC installation to access a global registry ..............................
Installing CTS DAR files .........................................................................
Deleting version 6.0 DocApps .............................................................
Configuring headless Composer ..........................................................
Installing a DAR file with DAR Installer Plugin ....................................
Configuring a CTS product to the global registry ......................................
Installing the CTS Activity Template ............................................................
Pre‑installation requirements ..................................................................
Install CTS Activity Template ..............................................................
Confirming installation of CTS Activity Java Method ........................
Installing CTSActivity DAR file on a Windows/Unix
repository with DAR Installer Plugin ...............................................
Validating and installing CTS Activity Template .......................................
Installing Branch Office Caching Services .....................................................
Installation troubleshooting.........................................................................
Cannot pass SuperUser and repository user information screen .................
If Advanced Document Transformation Server installation fails .................
If cts_instance_info is not created when the Configurator is
executed ................................................................................................
Configuring for WordPerfect version 10 or 11 ...........................................
Chapter 4
4
Verifying, Expanding, Removing, and Uninstalling Advanced
Document Transformation Services ......................................................
Verifying the Advanced Document Transformation Services
installation .................................................................................................
Verifying startup of Advanced Document Transformation Services ............
Verifying installation using DAM or Web Publisher ..................................
Expanding Advanced Document Transformation Services.............................
Configuring Advanced Document Transformation Server for
another repository ..................................................................................
Removing the Advanced Document Transformation Server
instance from a repository ...........................................................................
Uninstalling Advanced Document Transformation Services ..........................
Uninstalling Content Transformation Services ..............................................
Uninstalling the CTS Activity Template from a Windows host .......................
Uninstalling the CTS Activity Template from a UNIX host ............................
34
34
35
38
41
43
44
44
45
45
47
48
48
49
50
51
53
54
57
57
58
58
58
61
61
62
62
63
63
64
65
66
67
68
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Table of Contents
List of Figures
Figure 1.
Figure 2.
Typical Advanced Document Transformation Services installation .....................
Processing a request for a PDF rendition ..........................................................
12
15
Figure 3.
Figure 4.
Processing a request for an HTML rendition.....................................................
Profile Migration Confirmation Dialog Box ......................................................
16
23
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
5
Table of Contents
List of Tables
Advanced Document Transformation Services features .....................................
Supported capabilities with Advanced Document Transformation
Services .....................................................................................................
Supported transformations with Advanced Document
Transformation Services ..............................................................................
16
Table 4.
Rendering applications for supported source formats .......................................
21
Table 5.
Required Advanced Document Transformation Server installation
information ................................................................................................
35
Description of DAR Installer Fields (CTS DAR) ................................................
Description of DAR Installer Fields (CTS Activity Template) .............................
46
52
Table 1.
Table 2.
Table 3.
Table 6.
Table 7.
6
18
20
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Preface
This guide describes how to install Documentum Advanced Document Transformation Services for
Windows. It lists installation prerequisites and provides step‑by‑step instructions for installing and
uninstalling the Advanced Document Transformation Server. In addition, this manual includes a brief
overview of Advanced Document Transformation Services architecture.
You can find additional information about Advanced Document Transformation Services in the
following documents:
•
Advanced Document Transformation Services Administration Guide, which describes the functionality
of Advanced Document Transformation Services and how to configure and troubleshoot
Advanced Document Transformation Services.
•
Advanced Document Transformation Services Release Notes, which includes important notes on
installation and administration issues, requirements, and limitations. This document also
references some bugs.
•
Content Transformation Services Product Development Guide, which explains how to use the Content
Transformation Services plug‑in SDK to create and configure your own plug‑ins for Advanced
Document Transformation Services. Contact your account representative for availability of the
Content Transformation Services Product Development Guide.
See the appropriate Documentum product documentation for information on related Documentum
products.
Intended audience
This guide is intended for the person who installs Advanced Document 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.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
7
Preface
Revision history
The following changes have been made to this document.
Revision history
8
Revision date
Description
August 2008
Initial publication for version 6.5 product release.
October 2008
Revised DAR file installation procedures in Chapter 3.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Chapter 1
Advanced Document Transformation
Services Overview
This chapter contains a brief overview of Advanced Document Transformation Services and outlines
a typical Advanced Document Transformation Services installation. It gives a basic description
of the Documentum environment and relates the Advanced Document Transformation Services
components within the installation.
This chapter contains the following sections:
•
What is Content Transformation Services?, page 9
•
What is Advanced Document Transformation Services?, page 11
•
Features of Advanced Document Transformation Services, page 16
•
Capabilities of Advanced Document Transformation Services, page 18
•
Supported transformations by source and target formats, page 19
•
Rendering applications for supported source formats, page 20
•
Working with the CTS Activity Template , page 22
•
Confirming migration of profiles dialog box, page 22
What is Content Transformation Services?
Content Transformation Services (CTS) is a name used for a set of Documentum server
products that perform transformations and analysis on repository content. CTS includes
these main products:
•
Advanced Document Transformation Services (ADTS)
•
Document Transformation Services (DTS)
•
Media Transformation Services (MTS)
•
XML Transformation Services (XTS)
Additional components are available for some of these products. For example, Media
Transformation Services can be extended by installing additional transformation services,
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
9
Advanced Document Transformation Services Overview
such as Audio/Video Transformation Services (AVTS). These components supplement
the features already provided by the base product, according to your organization’s
requirements.
Content Transformation Services scalability
Content Transformation Services (CTS) products allow for a high level of scalability. All
CTS products run under the same Windows Service on the CTS host. This means that
stopping or starting the CTS service stops or starts all the CTS products on that host.
For example, if your CTS host contains Advanced Document Transformation Services
and Media Transformation Services, stopping the CTS Windows Service stops both
of those products.
Each CTS product can be configured for multiple repositories. If you have one installation
of a product on a host, that installation can be configured against different repositories.
CTS scalability also allows for several instances of Content Transformation Services
products on different hosts to be configured for the same repository. This means that
your installation can take either of two forms: one with identical plug‑in capabilities,
or one with different plug‑in capabilities.
The ability for each instance of Advanced Document Transformation Server to handle
different plug‑ins means that you can have each instance dedicated to a specific type
of transformation. For example, you might have a dedicated Advanced Document
Transformation Server for Microsoft Word and Excel transformations, and a dedicated
Advanced Document Transformation Server for Microsoft PowerPoint transformations.
In this case, each instance has different plug‑ins, but all instances point to the same
repository.
The other benefit of having identical Advanced Document Transformation Services
installations is that a hardware failure in one instance will not stop all installations
from processing queue items. In cases where each instance of an Advanced Document
Transformation Server has different plug‑in capabilities, each server accepts only those
items from the processing queue that it is capable of handling.
To enable this functionality, Content Transformation Services has format awareness.
Format awareness is the ability for a Content Transformation Services product to
recognize which file formats it is capable of processing. Items that cannot be processed
successfully will be removed from the queue automatically. For example, if several
transformation requests are made for MOV files, but the product does not support
MOVs, the system will remove those items from the queue. A check for unprocessed
items is performed periodically.
10
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Advanced Document Transformation Services Overview
What is Advanced Document Transformation
Services?
Advanced Document Transformation Services is server software that generates copies
of documents in Portable Document Format (PDF) and HyperText Markup Language
(HTML). You can use Documentum client applications to request such a copy (called
a rendition) of a document stored in a Documentum repository. The transformation
capabilities of Advanced Document Transformation Services include PDF assembly,
header/footer creation, security, textual watermarking, and content overlays.
Advanced Document Transformation Services can also provide PDF transformations
from other file formats such as image and email formats.
Some Documentum client applications may not provide both PDF and HTML renditions;
consult the documentation for the client you are using.
Note: Advanced Document Transformation Services cannot process documents that are
locked (that is, checked out from the repository).
Advanced Document Transformation Services
components
Advanced Document Transformation Services is an added component to your basic
Documentum installation that includes Content Server and defined repositories with file
stores. The following sections detail the main components that make up a Advanced
Document Transformation Services installation.
Advanced Document Transformation Services environment
Figure 1, page 12 shows a typical Advanced Document Transformation Services
installation on the Documentum platform.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
11
Advanced Document Transformation Services Overview
Figure 1. Typical Advanced Document Transformation Services installation
Advanced Document Transformation Server
Advanced Document Transformation Services is integrated with Documentum Content
Server to process, store, and manage files within the Documentum schema. When users
import files or request file transformations, the Content Server stores the register and
request objects in a queue. The Advanced Document Transformation Server will poll
that queue intermittently, looking for register and request objects. The file is then passed
to the appropriate plug‑in for processing.
When the processing is complete, the Advanced Document Transformation Server
updates the original objects with new renditions or creates the new objects, as requested.
The objects are saved to the repository and the requests are removed from the queue.
The objects are then ready for use.
Documentum Foundation Classes
The Documentum Foundation Classes (DFC) are a set of Java classes that provide
access to Content Server functionality. Web‑based applications, such as Digital Asset
Manager and Web Publisher, make calls directly to the DFC or indirectly through the
Web Development Kit (WDK).
DFC must be installed on the Advanced Document Transformation Services host, and is
included with the installer. During installation, the Advanced Document Transformation
12
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Advanced Document Transformation Services Overview
Services installer checks for an existing DFC on the host. The following scenarios are
possible:
•
If DFC does not exist on the host, the installer installs the correct version.
•
If an older version of DFC exists on the host, it is replaced by the version included
with the installer. Refer to the relevant version of the Documentum System Migration
Guide available at Powerlink at www.powerlink.emc.com for more information on
migration issues. Follow the Technical Documentation and Advisories > Software
~ D ~ Documentation > Documentum System > link.
Any applications that were dependent upon the older version of the DFC will have
to be upgraded as well. For more information on the DFC and its effect on other
applications, refer to your specific Documentum application documentation.
•
If a version of DFC exists and it is newer than that which is included with the
installer, it will be left untouched. If the existing version of DFC is the same as the
one in the installer, DFC is ʺrefreshedʺ.
Advanced Document Transformation Services plug­ins
The Advanced Document Transformation Server plug‑ins enable users to transform a
variety of files from one format to another (for example, from DOC to PDF or HTML).
During an installation of Advanced Document Transformation Services, all standard
plug‑ins are installed.
The standard Advanced Document Transformation Server plug‑ins are as follows:
•
Word — transforms Microsoft Word files to HTML.
•
Excel — transforms Microsoft Excel files to HTML.
•
PowerPoint — transforms Microsoft PowerPoint files to HTML.
•
WordPerfect — transforms Corel WordPerfect files to HTML.
•
AdvancedPDF — enables PDF support and creates hyperlinks and bookmarks.
•
PDF Storyboard — generates thumbnails and storyboards.
•
MIME — transforms MSG and EML files to text or rich text.
•
EMCMail — transforms EMCMF to PDF and HTML.
The plug‑ins are extensible. You can configure plug‑in types and formats, and you can
add new plug‑ins to the system to support new file formats as required. For information
about creating and adding new plug‑ins, see the Content Transformation Services Product
Development Guide, or contact your Documentum account or support representative.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
13
Advanced Document Transformation Services Overview
How Advanced Document Transformation Services
works
The following sections detail how Advanced Document Transformation Services creates
PDF and HTML renditions.
How Advanced Document Transformation Services creates PDF
renditions
The following steps describe how Advanced Document Transformation Services
produces PDF renditions in response to client requests:
1.
The client application sends the rendition request to Documentum Content Server.
Note: Advanced Document Transformation Services modifies the document object,
so it cannot process locked (checked out) documents.
2.
Content Server stores the request in a queue called dm_queue.
3.
Advanced Document Transformation Server polls dm_queue at predefined intervals,
and retrieves any pending requests.
4.
When Advanced Document Transformation Services finds a PDF rendition request
in the queue, it checks the format of the document and generates a PDF rendition
based on what the default profiles specify (through legacy client invoking).
5.
Content Server adds the PDF rendition to the object in the repository.
An object represents a parent file, with all of its associated graphics, text, and
renditions, in the repository. Once a rendition has been added to the object, users
can view the rendition from the client application.
Figure 2, page 15 illustrates this rendition process.
14
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Advanced Document Transformation Services Overview
Figure 2. Processing a request for a PDF rendition
How Advanced Document Transformation Services creates HTML
renditions
The following steps describe how a Advanced Document Transformation Services host
produces HTML renditions in response to client requests:
1.
The client application sends the rendition request to the Content Server.
Note: Advanced Document Transformation Services cannot process documents that
are locked (checked out from the repository).
2.
Content Server stores the request in a queue called dm_queue.
3.
Advanced Document Transformation Server polls dm_queue at predefined intervals,
and retrieves any pending requests.
4.
When Advanced Document Transformation Services finds an HTML rendition
request in the queue, it checks the format of the document. Advanced Document
Transformation Services invokes the corresponding application to open the file and
then saves an HTML version.
•
If the result is a single HTML file, Advanced Document Transformation Services
sends this file to the Content Server.
•
If the result consists of multiple files (for example, HTML, graphics, and XML
files), Advanced Document Transformation Services creates a Zip file containing
these files, and sends the Zip file to Content Server. The Zip file includes any
folders the application creates to contain these files.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
15
Advanced Document Transformation Services Overview
5.
Content Server adds the HTML or Zip file to the repository as a rendition of the
document object.
An object represents a parent file, with all of its associated graphics, text, and
renditions, in the repository. Once a rendition has been added to the object, users
can view the rendition from the client application.
Figure 3, page 16 illustrates the rendition process.
Figure 3. Processing a request for an HTML rendition
Features of Advanced Document
Transformation Services
Advanced Document Transformation Services offers an extensive range of features,
as listed in the following table.
Table 1. Advanced Document Transformation Services features
Feature
Comments
Runs as Windows Service and intelligently
handles exceptions raised by native applications.
Transforms common document formats into
PDF and HTML.
16
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Advanced Document Transformation Services Overview
Feature
Comments
Creates automated transformations.
Not available out of the box;
configuration required. See
Advanced Document Transformation
Services Administration Guide.
Creates new renditions.
Transforms a document as part of a business
workflow process using the CTS Activity
Template.
CTS Activity Template is
included. See the Advanced
Document Transformation Services
Administration Guide for details.
See Installing the CTS Activity
Template, page 48 for installation
instructions.
Creates PDF/X and PDF/A compliant renditions.
Integrates with entire Documentum product
suite.
Merges multiple files into a single PDF file.
Splits a PDF file into multiple volumes.
Adds watermarks and overlays.
Creates headers and footers.
Auto‑generates TOC from a merged PDF file.
Auto‑generates page numbers.
Adds attachments to PDF.
Generates thumbnail, storyboard, and
low‑resolution renditions of some imported files.
Controls PDF job parameters such as page size,
layout, and security.
Creates new objects that are related to the
original object.
Preserves bookmarks and hyperlinks in source
documents.
Transforms image formats to PDF.
Transforms CAD drawings to PDF.
Requires the installation of Myriad
7.0*.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
17
Advanced Document Transformation Services Overview
Feature
Comments
Transforms Microsoft Project files to PDF.
Requires the installation of
Microsoft Project*.
Transforms Microsoft Visio files to PDF.
Requires the installation of
Microsoft Visio*.
Transforms EMCMF to MSG
See Advanced Document
Transformation Services
Administration Guide.
Transforms MSG to EMCMF
See Advanced Document
Transformation Services
Administration Guide.
Transforms EMCMF to PDF and HTML
See Advanced Document
Transformation Services
Administration Guide.
* These rendering applications must be purchased separately.
Capabilities of Advanced Document
Transformation Services
Advanced Document Transformation Services creates thumbnail, storyboard, and
low‑resolution renditions for all supported source formats. Thumbnail, storyboard,
and low‑resolution renditions are not available out of the box. Some configuration is
required. See Advanced Document Transformation Services Administration Guide for details.
The following table details the capabilities of Advanced Document Transformation
Services.
Table 2. Supported capabilities with Advanced Document Transformation Services
Input
format
18
Creates
thumbnail*
Creates
storyboard*
Creates low‑
resolution
rendition*
Writes
XMP to
content
Extracts
XMP from
content
AutoCAD
√
√
√
BPM
√
DOC,
DOCX
√
√
√
√
DOT, DOTX
√
√
√
√
√
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Advanced Document Transformation Services Overview
Input
format
Creates
thumbnail*
Creates
storyboard*
Creates low‑
resolution
rendition*
Writes
XMP to
content
Extracts
XMP from
content
EML
EPS
GIF
√
HTML
√
JPEG
√
MPP
√
√
√
PDF
√
√
√
POT, POTX
√
√
√
√
PPT, PPTX
√
√
√
√
PS
√
√
√
RTF
√
√
√
TIFF
√
√
√
TIFF (multi‑
page)
√
√
√
TXT
√
√
√
VSD
√
√
√
WPD
√
√
√
XLS, XLSX
√
√
√
√
XLT, XLTX
√
√
√
√
√
√
√
√
MSG
√
√
* Thumbnail, storyboard, and low‑resolution renditions are not available out of the
box. Some configuration is required. See the Advanced Document Transformation Services
Administration Guide for details.
Supported transformations by source and
target formats
The supported transformations are dependent upon the installation of a variety of
applications on the Advanced Document Transformation Server, as detailed in Table 4,
page 21.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
19
Advanced Document Transformation Services Overview
With the required supporting applications installed, Advanced Document
Transformation Services can perform the following transformations.
Table 3. Supported transformations with Advanced Document Transformation Services
Source formats (input)
Target formats (output)
BMP, EPS, GIF, JPG, TIFF (single and multi‑page)
PDF, PDF/A
DOC, DOCX, DOT, DOTX
PDF, PDF/A, HTML
DWF, DWG, DXF
PDF, PDF/A
EML
TXT, PDF, PDF/A
EMCMF (EMCMail)
HTML, MSG, PDF
HTML
PDF, PDF/A
MPP
PDF, PDF/A
MSG
EMCMF, TXT, RTF, PDF,
PDF
PDF, HTML
POT, POTX, PPT, PPTX
PDF, PDF/A, PDF/X, HTML
VSD
PDF, PDF/A, PDF/X
WPD
PDF, PDF/X, HTML
XLS, XLSX, XLT, XLTX
PDF, HTML
Rendering applications for supported source
formats
The supported transformations are dependent upon the installation of a variety of
applications on the Advanced Document Transformation Server host, as detailed in
the following table.
Note: All of the required rendering applications named in Table 4, page 21 must be
obtained separately by the customer. They are not included in the purchase of Advanced
Document Transformation Services.
English, Japanese, and Korean rendering applications are supported on English,
Japanese, and Korean operating systems respectively.
Applications listed as mandatory must be installed on the host, regardless of whether
you are transforming files of the related source format or not. Without these mandatory
applications, Advanced Document Transformation Services will not function properly.
20
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Advanced Document Transformation Services Overview
Applications listed as optional are only required if you are transforming files of the
related source format.
Table 4. Rendering applications for supported source formats
Source format
Required rendering
applications
Mandatory or optional
Word
Microsoft Word
2000/XP/2003/2007 *
Mandatory
Excel
Microsoft Excel
2000/XP/2003/2007 *
Mandatory
PowerPoint
Microsoft PowerPoint
2000/XP/2003/2007*
Mandatory
Outlook (MSG, EML)
Microsoft Outlook
2000/XP/2003*
Optional
WordPerfect
Corel WordPerfect 10/11/12
*^
Optional
PDF
Rendering tool installed with
ADTS.**
n/a
PostScript
AFPL Ghostscript 8.54
Optional
Text, RTF, HTML
Microsoft Word
2000/XP/2003/2007*
Mandatory
TIFF, EPS, JPG, BMP, GIF
Rendering tool installed with
ADTS.**
n/a
Project (MPP)
Microsoft Project
2000/XP/2003/2007*
Optional
Visio (VSD)
Microsoft Visio
2000/XP/2003*
Optional
CAD drawings
Informative Graphics
Myriad 7.0
Optional
* Advanced Document Transformation Services should have the latest version of the
rendering applications that the clients will be using. For example, if clients will be
transforming Word 2003 files, the Advanced Document Transformation Server should
have Word 2003 installed. Versions of Word older than 2003 may not be able to handle
documents created with Word 2003.
** Documentum does not support manual upgrades to any software installed by the
Advanced Document Transformation Services installer.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
21
Advanced Document Transformation Services Overview
^ By default, the WordPerfect plug‑in is configured for WordPerfect 12. If you are using
version 10 or 11, you must modify the plug‑in file to invoke the correct executable file.
See Configuring for WordPerfect version 10 or 11, page 58 for details.
Working with the CTS Activity Template
The CTS Activity Template allows users to add a content transformation as part of a
workflow process. With this version of Document Transformation Services the CTS
Activity Template is available for use with Documentum Process Builder.
See Installing the CTS Activity Template, page 48 for the procedures required to install
the activity template. See Advanced Document Transformation Services Administration Guide
for instructions on how to make the activity template available to users.
Any user profile for Document Transformation Services can be used with the CTS
Activity Template. However, keep in mind that if a profile contains user‑defined
parameters, these parameters cannot be exposed within the workflow. See Advanced
Document Transformation Services Administration Guide for details about choosing profiles
and making them available for use with the Activity Template.
Confirming migration of profiles dialog box
During installation of Advanced Document Transformation Services, a dialog box
confirms the beginning of migration of profiles to version 6.5 with a reminder to backup
all profiles.
22
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Advanced Document Transformation Services Overview
Figure 4. Profile Migration Confirmation Dialog Box
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
23
Advanced Document Transformation Services Overview
24
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Chapter 2
Getting Started
This chapter explains how to prepare for installing Advanced Document Transformation Services on a
Windows host. It describes pre‑installation requirements. This chapter contains the following sections:
•
Selecting the server host, page 25 describes requirements for selecting the Advanced Document
Transformation Server host.
•
Installation prerequisites, page 26 describes software and setup that is required before installing
Advanced Document Transformation Services.
Selecting the server host
This section provides basic guidelines for selecting the host machine for your Advanced
Document Transformation Services installation.
Caution: To ensure optimal system performance, the Advanced Document
Transformation Server should not be installed on the same host as Content Server
or the FAST (Full Text Index) Server. This configuration is not supported by
Documentum.
The server name cannot exceed 15 bytes (an error message will display during
installation when trying to enter a host name that is longer then 15 bytes).
When selecting the Advanced Document Transformation Server host, consider
the amount of memory available on the candidate server. Advanced Document
Transformation Services requires an amount of memory equal to at least twice the size of
the largest file you expect to process. For example, if you expect users to transform files
of 1 GB, the Advanced Document Transformation Server host should have at least 2 GB
of memory to ensure efficient media processing.
As well, all Content Transformation Services products installed on a host use the
same Windows service. This means that any actions (such as starting and stopping an
application) performed on that Windows service affect all of the CTS products using it.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
25
Getting Started
The number of products installed on a single host, the expected usage of those products,
and the host’s hardware capabilities are major factors in selecting the host. If you are
planning to use the same host for more than one CTS product, ensure that it has sufficient
hardware and processing capabilities for optimal performance. For more information on
CTS scalability, see Content Transformation Services scalability, page 10.
Refer to the Advanced Document Transformation Services Release Notes for complete
information on hardware and software requirements.
Installation prerequisites
This section describes the prerequisites for a successful Advanced Document
Transformation Services installation.
The Advanced Document Transformation Services Release Notes provide complete
information on hardware, operating system, and software version requirements.
Software prerequisites
The following software must be installed, configured, and running properly on your
network before you install Advanced Document Transformation Services:
•
Documentum Content Server
The following software must be installed, configured, and running properly on the
Advanced Document Transformation Server host before you install Advanced Document
Transformation Services:
•
Microsoft Windows as the operating system
•
Microsoft Office (required) and any additional rendering applications listed in
Rendering applications for supported source formats, page 20
•
.NET Framework
•
Microsoft Message Queue (MSMQ)
•
Internet Information Services (IIS) and ASP.Net
•
Documentum Administrator
•
Documentum headless Composer
Note: The Advanced Document Transformation Services Release Notes list the software
versions certified to run with your version of Advanced Document Transformation
Services.
Preparing the Advanced Document Transformation Services host, page 32 provides
installation instructions for .NET Framework, MSMQ, IIS, and ASP.Net.
26
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Getting Started
Uninstalling older versions of Documentum
Transformation Software
If you are installing Advanced Document Transformation Server on a host that has
Content Rendition Services, AutoRender Pro, or a previous version of any Content
Transformation Services product, you must properly uninstall them first. If you do not
uninstall previous versions, your new installation of Content Transformation Server and
Advanced Document Transformation Server may fail. See Uninstalling previous versions
of Documentum Transformation Software, page 31 for more information.
Setup verifications
Prior to installation, verify the following:
•
WinZip or a similar file‑extraction utility is installed on the host machine.
•
If you already have a dfc.properties file, it is pointing to the correct Connection
Broker. Identifying a Connection Broker in dfc.properties, page 27 provides
instructions.
•
The Connection Broker and repository services are running on your Content Server.
Checking Connection Broker and repository services, page 28 provides more
information on this topic.
Identifying a Connection Broker in dfc.properties
If you already have Documentum Foundation Classes (DFC) installed on your Advanced
Document Transformation Services host, you will have a dfc.properties file. Follow this
procedure to ensure that the correct Connection Broker is specified. If you are installing
Advanced Document Transformation Services on a clean host, you will not have a
dfc.properties prior to installation; in this case, the following procedure is not required.
For more information on the Connection Broker, see the Content Server Administration
Guide.
To identify the correct Connection Broker in dfc.properties:
1.
Search for the dfc.properties file on your Advanced Document Transformation Server
host. The file is usually located in the Windows (:\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.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
27
Getting Started
4.
Save and close the dfc.properties file.
Checking Connection Broker and repository services
The Connection Broker and repository services must be running properly on the Content
Server host before you install Advanced Document Transformation Services. The Content
Server Administration Guide should be referenced for information and instructions
pertaining to Connection Broker and repository services.
28
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Chapter 3
Installing Advanced Document
Transformation Services
This chapter explains how to install Advanced Document Transformation Server on a Windows
host. It describes the installation process, provides information needed to perform the installation,
and contains step‑by‑step instructions for installing Advanced Document Transformation Server.
Post‑installation tasks, configuration tasks, and troubleshooting information are also provided.
This chapter contains the following sections:
•
Pre‑installation steps, page 29
•
Installing rendering software applications, page 33
•
Installing and configuring Advanced Document Transformation Server, page 34
•
Installing the CTS Activity Template, page 48
•
Installing Branch Office Caching Services, page 54
•
Installation troubleshooting, page 57
Chapter 4 explains how to uninstall Advanced Document Transformation Server.
Pre­installation steps
This section explains what to do before you install the Advanced Document
Transformation Server. It specifies the software to install before you start, and explains
how to configure it.
Backup all profiles
All profiles must be removed from the repository before installing a Content
Transformation Services 6.5 product. If any profiles have been customized, they should
be backed up by exporting them to a local disk.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
29
Installing Advanced Document Transformation Services
Remove old profiles
The profiles used in Content Transformation Services products are not removed from
the host when a product is uninstalled. Regardless of whether any customizations have
been made to profiles from a previous release, you must remove the prior versions of
the profiles so that all of the new profiles get installed properly. Any customization
must be manually migrated to the new profiles after the 6.5 product is installed. These
changes cannot be captured automatically.
To manually remove old profiles and migrate customizations to the new
profiles:
1.
Uninstall the previous version.
2.
Back up any customized profiles from the previous version.
3.
Navigate to the System cabinet and delete the Media Server folder (including all
versions and descendents).
4.
Install the version 6.5 product, so that the new profiles are installed to /System/Media
Server.
5.
Stop the Content Transformation Services service.
6.
Manually update the new profiles to reflect any desired customization, if applicable,
after upgrading all CTS products.
7.
Restart the Content Transformation Services service.
Downloading installers
Before beginning the installation process, it is best to have the installer ready and
available on your Advanced Document Transformation Services host. Download the
installer from the EMC Download Center ( https://emc.subscribenet.com) to a temporary
directory on your Advanced Document Transformation Services host. The download
files for this product are listed under Documentum Advanced Document Transformation
Services.
Unzip any zipped files before you proceed with the installation.
30
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
Uninstalling previous versions of Documentum
Transformation Software
Before you install Advanced Document Transformation Services, you must uninstall
any previous versions of Advanced Document Transformation Services, Content
Transformation Services products, Content Rendition Services (as Document
Transformation Services was known prior to version 5.3), or AutoRender Pro (as it
was known prior to version 5.2). To uninstall version 5.3 of a Content Transformation
Services product, refer to the Release Notes for the 5.3 version.
To uninstall a previous version of Advanced Document Transformation Services, refer to
the procedure in the Installation Guide for the version you are removing.
To uninstall previous Content Rendition Services or AutoRender Pro
installations:
1.
On the host machine, select Start > Settings > Control Panel and double‑click
Add/Remove Programs.
2.
In the Change or Remove Programs window, locate the AutoRender Pro or Content
Rendition Services program. Select it, and click Change/Remove.
3.
In the Change/Remove dialog box, click Next.
4.
Follow the steps in the Uninstall Wizard.
5.
If it exists, delete the ARP subdirectory located in your Documentum installation
directory.
6.
Find any previous versions of the following files and/or directories and delete them:
•
C:\WINNT\system32\arpgen.exe
•
C:\dmautop (delete entire directory)
Caution: Consult the Release Notes for the specific version of Content Rendition
Services or AutoRender Pro that exists on the host for any known uninstallation
issues.
Confirming Print Spooler service
A Microsoft Windows service called Print Spooler must be running before you install
any applications. PDF files cannot be generated without this service.
To check that the Print Spooler service is started:
1.
Go to Start > Control Panel > Administrative Tools > Services.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
31
Installing Advanced Document Transformation Services
2.
Locate Print Spooler by scrolling through the list box.
3.
Ensure that the Print Spooler status is Started, and that the Startup Type is
Automatic.
4.
If changes are required, double‑click on Print Spooler to open the dialog box.
5.
Make the required changes, and click Apply.
Preparing the Advanced Document Transformation
Services host
Before installing the Advanced Document Transformation Server, you must install
several applications and other components on the server host. Advanced Document
Transformation Services Release Notes provides information on specific versions of software
supported for this release.
The following components are not bundled in the installer and must be installed
independently prior to installing Advanced Document Transformation Services:
•
Microsoft .NET Framework
•
Internet Information Services (IIS)
•
ASP.Net (for Windows 2003 server only)
•
Microsoft Message Queue (MSMQ)
To complete the mandatory pre­installation requirements for Windows
2003 server:
1.
Go to the Microsoft download site at
http://msdn2.microsoft.com/en‑us/netframework/default.aspx
Follow the directions for installing the version of Microsoft .NET Framework
specified in the Advanced Document Transformation Services Release Notes.
2.
Log in to the host as an administrator user.
3.
Install Internet Information Services (IIS), ASP.Net, and Microsoft Message Queue
(MSMQ):
a.
Open the Control Panel from the Windows Start Menu.
b. Double‑click the Add/Remove Programs icon.
c.
Click on Add/Remove Windows Components. The Windows Components
Wizard appears.
d. Select Application Server from the list box.
e.
32
Click Details. The Application Server window appears.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
f.
Select ASP.Net from the list box. The IIS and Enable network COM+ access
options are automatically selected.
g. Select Message Queuing and click Details.
h. Select Common; deselect everything else.
i.
Click OK. The Windows Components Wizard reappears.
j.
Click Next and continue to follow the installation instructions on your screen.
Note: Make sure all installed programs are started and the registration dialog has been
dismissed. The registration screen that appears in some newly installed programs may
interfere with Advanced Document Transformation Services processing. Be sure to close
the applications before installing the Advanced Document Transformation Server.
Now proceed to install the rendering applications. Go to Installing rendering software
applications, page 33.
Installing rendering software applications
The installation of Microsoft Office is a mandatory requirement for Advanced Document
Transformation Services.
In addition, you must install the applications corresponding to any additional file
formats you wish to render, such as Corel WordPerfect. For example, if you want
to render WordPerfect documents into PDF or HTML, the Advanced Document
Transformation Services host must have Corel WordPerfect installed.
These applications must be installed with all options. Some applications give you the
choice of installing them with either minimal or full options. Applications installed
with minimal options may not run correctly with Advanced Document Transformation
Services.
The Advanced Document Transformation Services Release Notes describe the supported
rendering software applications. These applications must be installed in the default
directory.
For instructions on how to install rendering applications, refer to the installation guide
for each application.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
33
Installing Advanced Document Transformation Services
Installing and configuring Advanced Document
Transformation Server
Before installing Advanced Document Transformation Server for the first time, ensure
that you have fulfilled all of the pre‑installation prerequisites detailed in this document.
After installing Advanced Document Transformation Server, you can verify that your
installation is running correctly. Verifying the Advanced Document Transformation
Services installation, page 61 explains this procedure.
If you have already installed Advanced Document Transformation Server, but would like
to add a new instance to a repository, Expanding Advanced Document Transformation
Services, page 63 provides instructions for doing so.
Advanced Document Transformation Services
installation overview
Advanced Document Transformation Server installation is accomplished as a two‑part
process:
1.
Install Advanced Document Transformation Server.
2.
Configure Advanced Document Transformation Server to at least one repository.
Note: CTS DAR files need to be installed prior to running the Configuration Utility.
See Installing CTS DAR files, page 44 for further information.
The Advanced Document Transformation Server installation includes the required
Documentum Foundation Classes (DFC) Runtime Environment, the necessary Java
components, the underlying Content Transformation Services service and supporting
files, the Content Transformation Services Administration Agent, and the Advanced
Document Transformation Services supporting files.
To create an additional instance of Advanced Document Transformation Server
(described in Expanding Advanced Document Transformation Services, page 63), or to
remove Advanced Document Transformation Server from a repository (described in
Removing the Advanced Document Transformation Server instance from a repository,
page 64), you do not have to run the installer again. The Configurator allows you to add
and remove instances of Advanced Document Transformation Services, and will be
accessible from the Windows Start menu after installation.
If you are reinstalling Advanced Document Transformation Server, you must properly
uninstall your previous version of Advanced Document Transformation Server first.
If you do not uninstall Advanced Document Transformation Services first, your new
34
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
installation may fail. Refer to Uninstalling Advanced Document Transformation
Services, page 65.
Required Advanced Document Transformation Server
installation information
The table in this section allows you to record the information you need to install
Advanced Document Transformation Server. Having this information ready and
available prior to installation ensures the accuracy and efficiency of your installation.
Table 5. Required Advanced Document Transformation Server installation information
Installation information
Description
DFC installation directory
This is the destination
directory for DFC.
Your value
The default directory
is C:\Program
Files\Documentum.
DFC user directory
This is where the log files
for DFC and Advanced
Document Transformation
Server 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 DFC 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 Advanced
Document Transformation
Server.
(if not detected)
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
35
Installing Advanced Document Transformation Services
Installation information
Description
Advanced Document
Transformation Server
installation directory
The directory in
which to install
Advanced Document
Transformation Services. It
is recommended that you
use a subdirectory of the
directory in which other
Documentum products are
installed.
Your value
For example, if
other Documentum
products are installed
in D:\Documentum, install
Advanced Document
Transformation Server in
D:\Documentum\CTS.
The installer will create the
CTS folder for you.
Advanced Document
Transformation Server host
(if not detected)
The name of the machine
on which you are installing
Advanced Document
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.
36
Admin User name and
password
The name of the admin user
who is installing Advanced
Document Transformation
Server.
Repository SuperUser
name and password
The account the Advanced
Document Transformation
Server uses to log in to
the repository. Ask your
administrator to supply
you with a SuperUser
name and password.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
Installation information
Description
Repository user name
The name of the user who
will receive notifications
from Advanced Document
Transformation Server.
Your value
Advanced Document
Transformation Services
notifies the user of the
results of processing. For
example, if Advanced
Document Transformation
Server fails to process a
particular item, it queues
an event to the Inbox of
the Advanced Document
Transformation Server
system operator user
(sysOpUser).
CTS Admin Port
The port used
by Documentum
Administrator to
communicate with Content
Transformation Services
installations. 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 DFC installations
can use different global
registries where required
service‑based objects or
network locations are
stored. A single DFC
installation can have only
one global registry. You
will be prompted during
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
37
Installing Advanced Document Transformation Services
Installation information
Description
Your value
installation for the primary
registry.
dm_bof_registry
By default, the global
registry user has
the user name of
dm_bof_registry.During
repository configuration,
provide the user login
name and password for the
global registry user. The
global registry user should
be someone other than the
administrator.
Installing Advanced Document Transformation Server
The following procedure will install the Advanced Document Transformation Server,
the necessary Java components, and the DFC. Complete the information in Table 5,
page 35 prior to performing this procedure.
Note: Some screens mentioned below may not appear during your installation,
depending on what is already installed on the Advanced Document Transformation
Services host.
If you are installing Advanced Document Transformation Services through remote
desktop, launch the remote desktop with the following command :
mstsc.exe /console
To install Advanced Document Transformation Server:
38
1.
Log in to the selected Advanced Document Transformation Server host as an
administrator user.
2.
Ensure that no programs or applications are running on the host.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
3.
Navigate to the folder containing the unzipped Advanced Document Transformation
Server installation files. Downloading installers, page 30 provides information about
where the files should be located.
4.
Double‑click adtsWinSuiteSetup.exe.
The Advanced Document Transformation Services 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 the option to accept the terms of the license agreement, then click Next.
7.
The Installer checks for any versions of the DFC currently installed on the host.
If a newer version of DFC is already installed, the Installer will not replace it.
8.
The DFC Runtime Environment Optional Features screen appears. If you want to
install the Developer Documentation and/or the Primary Interop Assembly Installer,
select these options. Click Next.
At this point, if the correct version of the DFC is already installed, go to .
If an older version of the DFC is installed, you are given a warning that the version is
not supported by this version of Advanced Document Transformation Server. It is
recommended that you uninstall this version of the DFC, or select a different host.
9.
On the Directory for Documentum Software screen, change the destination folder
for DFC (the default is C:\Program Files\Documentum\), if required, then click
Next. To accept the default, click Next.
Note: If you already have the correct version of the DFC on your system, you will
not see this screen; go to Step 12.
10. You are prompted to enter the User Directory for DFC Runtime Environment. This is
where exported documents, checked out documents, and DFC log files are stored.
The default directory is C:\Documentum.
If required, change the user directory for DFC, then click Next. To accept the default
directory, click Next.
Note: If you already have the correct version of the DFC on your system, you will
not see this screen; go to Step 12.
11. You are prompted to enter a Connection Broker host name (or IP address) and port
number.
Type the name of the Connection Broker host name in the Connection Broker
Host Name field and, optionally, type the port number in the Port Number field,
and click Next.
Note: If you already have the correct version of the DFC on your system, you will
not see this screen; go to Step 12.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
39
Installing Advanced Document Transformation Services
12. Identify the Content Transformation Services installation directory (for core
components that all CTS products use). The Installer creates a directory named
CTS within the chosen directory.
It is recommended that you accept the default directory (for example, C:\Program
Files\Documentum\CTS), which is where any other Documentum products are
installed.
•
To accept the default directory, click Next.
•
To choose another directory, click Browse, navigate to the directory, and click
Next.
13. Identify the host name of the host machine. This may be detected automatically, if
you are installing directly from the host. Otherwise, enter the network host name,
and click Next.
14. Identify the port number to which the CTS Administration Agent will be configured.
This port is used in conjunction with Documentum Administrator to communicate
with CTS hosts. The default port number is 9095. Enter a port number and click Next.
The Admin user name and password screen appears.
15. Enter the Admin user name and password; if you are installing for a domain user,
use the format <username>@<domain> in the Admin user name field.
Click Next.
16. The Installer checks the host for the required rendering applications. If Microsoft
Office applications are missing (or not available in the default installation directory),
you are warned that Advanced Document Transformation Server will not be able
to support some file formats.
If you have already installed the recommended application, but it is located in a
directory other than the default, cancel the Installer and reinstall the rendering
application into the default directory.
If you do not wish to transform the file formats supported by the missing application,
click Next.
17. The Installation Summary screen appears, listing the applications that will be
installed.
Note: If the correct version of DFC is already installed, the summary screen will
show that DFC will be refreshed.
•
If you are satisfied with the installation confirmation, click Next.
•
If you want to change a component of the installation, use the Back button to
navigate back through the Installer and change the installation information.
18. The installation proceeds. If a message appears advising you that the _jvm directory
already exists, click Yes to overwrite the directory.
19. The installer now migrates all old profiles automatically. A dialog box appears
confirming the following information:
40
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
•
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.
20. A message notifies you that Advanced Document Transformation Server was
installed successfully. Click Next.
21. The DFC Global Registry designation screen appears. Identify the global registry
repository. Click the Designate the global registry box. Enter the repository name
and password. Click Test Connect, if desired. Click Next.
22. Enter the default global registry user name (dm_bof_registry) and password. This
should be someone other than the administrator. Click Next.
23. You are prompted to restart your system.
Select the appropriate option and click Finish.
Note: It is recommended that you restart your system after installation.
24. The Installation Wizard closes.
Note: If you selected to restart your Windows system immediately, the system will
restart.
Configuring an instance of Advanced Document
Transformation Server
To complete the Advanced Document Transformation Server installation, you must
configure an instance of Advanced Document Transformation Server.
Caution: Make sure the appropriate Connection Broker and repositories are
running before continuing with the configuration.
To configure an instance of Advanced Document Transformation Server:
1.
If the Configurator Wizard does not start up automatically after restarting the
system, navigate to the Advanced Document Transformation Services Configurator
under Start > Programs > Documentum > ADTS Configuration Utility.
2.
The Advanced Document Transformation Services Configurator splash screen is
displayed, followed by the Welcome screen.
Click Next.
3.
The license agreement terms are displayed.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
41
Installing Advanced Document Transformation Services
Select the option to accept the terms of the license agreement, then click Next.
4.
Select Add a Advanced Document Transformation Services instance to a
repository, and click Next.
5.
Enter the name of the Advanced Document Transformation Server host. The installer
may detect the host name for you. This will be the name of the machine on which
you have installed Advanced Document Transformation Server.
Click Next.
6.
A list of the repositories served by your Connection Broker appears. For
instructions on selecting a Connection Broker, see Identifying a Connection Broker in
dfc.properties, page 27. Select a repository to be served by the Advanced Document
Transformation Server and click Next.
7.
The User Information screen appears.
a.
Enter the SuperUser name that Advanced Document 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.
b. Enter the password for the SuperUser account.
c.
Enter the domain name. This is an optional field; if you are installing from a
local machine, this can be left blank.
d. Enter the name of the repository user who will receive notifications from
Advanced Document 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 Advanced
Document Transformation Server installation information, page 35 for details
regarding values for these fields.
Click Next.
If you cannot continue, check with the repository administrator to verify that the
users exist and that you entered the correct password in both fields.
8.
If the repository you have chosen is in a distributed environment, a screen will
appear with a list of Content Servers configured for the repository you have chosen
to configure with Advanced Document Transformation Server.
Select a Content Server from the list and select Process local content only.
For more information on Distributed Content Servers and the distributed
environment, see the Documentum Distributed Configuration Guide.
9.
42
If ADTS 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 docbase supports.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
•
Select the repository, which has BOCS configured. Click Next.
10. Enable the following information fields:
•
Allow BOCS Transfer
•
Prefer ACS Transfer
•
Allow Surrogate Transfer
11. The installation proceeds. The User Authentication screen appears. Enter the system
administrator name and password; if you are installing as a domain user, use the
format <username>@<domain> in the system administrator name field.
Click Next.
12. A dialog box indicates the success of the Advanced Document Transformation
Server configuration.
Click Finish.
The Configurator closes.
Enabling a DFC installation to access a global registry
This step is only necessary if you did not select a global registry during the installation,
or if the password for the global registry user has changed, or if you are updating the
dfc.properties with a different global registry than initially configured.
The dfc.properties file contains properties that relate to accessing the global registry.
To enable a DFC installation to access a global registry repository:
1.
On the DFC host, navigate to $DOCUMENTUM/config (UNIX or Linux) or
%DOCUMENTUM%\config (Windows).
2.
From a command prompt, execute the following command to generate the encrypted
form of the global registry user’s password:
java ­cp dfc.jar com.documentum.fc.tools.RegistryPasswordUtils
password_of_user
where password_of_user is the global registry user’s clear‑text password. In step
4 below, you will need to enter the encrypted form of this password in the
dfc.properties file.
3.
Open the dfc.properties file in a text editor.
4.
Modify the following attributes:
dfc.bof.registry.repository=global_registry_repository_name
dfc.bof.registry.username=user_login_name
dfc.bof.registry.password=encryped_password_of_user
where encryped_password_of_user is the encrypted password you generated in 2 above.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
43
Installing Advanced Document Transformation Services
5.
Save the dfc.properties file.
Installing CTS DAR files
You need to install CTS DAR files before configuring CTS products to get all the latest
changes/enhancements. Install the DAR files in the global repository and each repository
that is configured for Advanced Document Transformation Services.
There are two CTS DAR files:
•
Rich Media Services DAR file
•
Transformation DAR file
The DAR files can be installed from any machine with the latest version of headless
Composer and the DAR Installer plug‑in on the local machine. Headless Composer is
installed as part of Content Server version 6.5. Headless Composer can be found at
C:\Documentum\<product>\6.5\install\composer\composer\ComposerHeadless on
the Content Server Host.
If Content Server is of a version other than 6.5, you will need to download and install
headless Composer before attempting to install the CTS DAR files. Headless Composer is
available on the EMC download site as part of Documentum Developer Studio. Consult
the Documentum Composer User Guide for more information about Composer.
Note: You must have Superuser privileges for the repositories in which you are installing
the DAR files.
If you are upgrading from Advanced Document Transformation Services version 6.0,
you must delete existing version 6.0 DocApps before installing the DAR files.
Deleting version 6.0 DocApps
Follow this procedure only if you are upgrading from Advanced Document
Transformation Services version 6.0:
To delete version 6.0 DocApps:
44
1.
Log in to DAM as an administrator user.
2.
Navigate to the \Cabinet\System\Applications folder.
3.
Click the checkboxes for:
•
CTSTransformRequest
•
MediaProfile
•
ADTS_Signature
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
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 three folders.
7.
Click Continue to confirm the deletion.
8.
Check the Applications folder to ensure the folders are deleted.
Configuring headless Composer
The headless Composer zip file has the format DCTM_Headless_Composer_
<platform>_<version>.zip.
To configure headless Composer:
1.
Extract the headless Composer .Zip file to a directory of your choice on your local
machine. The directory name must not contain any spaces.
2.
Open the dfc.properties file at: ..\ComposerHeadless\plugins\com.emc.ide.external.
dfc_1.00\documentum.config with a text editor.
3.
Add the DFC and connection broker information, similar to the following:
dfc.docbroker.host[0]=[DocBroker IP address or host name]
4.
Save your changes and close dfc.properties.
Installing a DAR file with DAR Installer Plugin
You can use the DAR Installer Plugin to install a DAR file to a repository if you do not
want to use the interface within Composer. The DAR Installer plugin requires Composer
or Headless Composer to be installed, but does not launch the full Composer IDE. The
DAR Installer Plugin is useful in cases where you want to de‑couple the development
of DAR files from the installation of DAR files. It is also useful in situations where
installation of DAR files is required as part of a deployment process.
When you open the DAR Installer program, it creates three folders in your Composer
installation directory:
•
darinstallerconfig ‑ contains configuration files for the DAR Installer program
•
darinstallerlogs ‑ the default location of the log files
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
45
Installing Advanced Document Transformation Services
•
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: darinstaller_workspace_yyyy‑mm‑dd‑hh‑mm‑ss.
The DAR Installer requires you to fill in certain values that are marked with an asterisk
(*). All other fields are optional. For a description of the fields for the DAR Installer
Utility, see Description of DAR Installer Fields.
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 darinstaller.exe, which is located in the Composer root directory, to start the
DAR Installer Plugin.
4.
In the DAR Details section, specify values for the fields.
5.
In the Connection Broker Details section, specify values for Connection Broker
Host and Connection Broker Port and click Connect.
6.
In the Repository Details section, specify values for the fields and click Install to
install the DAR file to the repository.
Refer to the Description of DAR Installer Fields table to help guide you through the
DAR file install process.
7.
Repeat steps 2–4 for the next DAR file.
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 6. Description of DAR Installer Fields (CTS DAR)
46
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
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
Parameter
Required
Description
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
Yes
The port of the Connection
Broker Repository
Repository
Yes
The name of the repository
that you want to install
the DAR file to. Click on
the Connect button after
entering the Docbroker
host and port to retrieve the
available repositories.
User Name
Yes
The login name for the
repository
Password
Yes
The password for logging
into the repository
Domain
No
The domain where the
repository resides
Configuring a CTS product to the global registry
Ensure the global registry has the Content Transformation Services product configured
against it; otherwise the transformation and rich_media_services DAR files will need
to be manually run against the global registry. See Configuring an instance of Advanced
Document Transformation Server, page 41 for further information.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
47
Installing Advanced Document Transformation Services
Installing the CTS Activity Template
The following section outlines the procedures required to install and use the activity
template for Content Transformation Services. It is meant to supplement — not replace
— the information in the Documentum Process Builder documentation set. You should
be familiar with the Documentum Process Builder application and have access to the
Documentum Process Builder Installation Guide, Documentum Process Builder User Guide, and
Documentum Process Builder Release Notes before proceeding with the tasks in this section.
See Advanced Document Transformation Services Administration Guide for instructions on
how to make the activity template available to users.
Pre­installation requirements
In earlier releases of Documentum, the software that comprises Process Engine was
installed as part of the Content Server installation. Forms & BPM docapps (now known
as DAR file) were installed manually. In release 6.5, Documentum Process Engine
is installed separately on the server where the Content Server is hosted. Process
Engine installs all required DAR files like Forms DAR and BPM DAR. Upon successful
installation of Process Engine, installer will deploy bpm.ear file to JBoss deploy directory.
Before installing the CTS Activity Template, these actions are required:
1.
Install Process_Engine according to Documentum Process Engine Installation Guide.
2.
Install BPM according to Documentum Business Process Manager Installation Guide.
3.
Install and configure Advanced Document Transformation Services according to the
Advanced Document Transformation Services Installation Guide.
4.
Install Documentum Administrator according to Documentum Administrator
Installation Guide.
5.
Install the Documentum Process Builder DAR file according to the Documentum
Process Builder Installation Guide.
6.
Install the Documentum Process Builder Java files according to the Documentum
Process Builder Installation Guide.
Once these applications and components are installed, you can proceed with installing
the CTS Activity Template components.
48
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
Install CTS Activity Template
Installation of the template involves these procedures. Procedures are provided for both
Windows and UNIX . Follow the appropriate instructions for your host:
1.
Install the CTSActivity on the Content Server host.
2.
Verify the Java method installation.
3.
Install the CTSActivity DAR file into each repository where users will use the CTS
Activity Template with Documentum Process Builder.
4.
Validate and install the CTS Activity Template on Documentum Process Builder.
These procedures are described below.
To install CTSActivity on Windows:
1.
Download the CTS Activity Template for Documentum Process Builder for Windows
Installer from the Documentum Download Center to a temporary directory on your
Content Server Host.
2.
Expand the self‑extracting executable file: CTSActivity_6.5_windows.exe to a
temporary directory.
3.
Ensure the JBoss application server (Java Method server) is not running.
4.
Navigate to the temporary directory with the expanded installer files.
5.
Double click on the ctsActivityServerWinSetup.exe file. The Welcome screen lists
the components that will be installed.
6.
Click Next.
The software license agreement appears.
7.
Select the option to accept the terms of the license agreement, and click Next.
The installation proceeds. A confirmation screen appears when the installation
process is complete.
8.
The installation summary screen appears indicating the applications that will be
installed. If you agree with them, click Next.
9.
An information screen appears reminding you to install the DAR file and restart the
Java Method Server. Click Next.
A summary screen appears when the installation process is complete.
10. Click Finish.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
49
Installing Advanced Document Transformation Services
The CTS Activity is now installed. Follow the procedure to confirm that the Java Method
was successfully installed.
To run the CTSActivity Java Method Installer on UNIX:
1.
Download the CTS Activity Template for UNIX installer from the Documentum
Download Center to a temporary directory on your Content Server Host.
2.
Expand the installer TAR file to a temporary directory.
3.
Ensure the JBoss application server (Java Method server) is not running.
4.
Use the tar utility to transfer the downloaded file to a temporary directory using the
following command applicable for your operating system:
•
For Solaris: % tar ‑xvf CTSActivity_6.5_solaris.tar
•
For AIX: % tar ‑xvf CTSActivity_6.5_aix.tar
•
For HP‑UX: % tar ‑xvf CTSActivity_6.5_hpux.tar
•
For Linux: % tar ‑xvf CTSActivity_6.5_linux.tar
The file creates two files: ctsActivityServer<platform>Setup.bin and
ctsActivityServerFileSetup.jar. You will need to add execute permission to the
.bin file.
5.
Run the installer by entering ./ctsActivityServer<platform>Setup.bin. Click Next.
6.
The CTS Activity Template Installer splash screen is displayed, followed by the
Welcome screen. Click Next.
7.
The software license agreement appears. Click Next.
8.
Select the option to accept the terms of the license agreement, and click Next.
The installation summary screen appears indicating the applications that will be
installed. If you agree with them, click Next.
The installation process begins.
9.
An information screen appears reminding you to install the DAR file and restart the
Java Method Server. Click Next.
10. A summary screen appears when the installation process is complete.
11. Click Finish.
The CTS Activity is now installed. Go to Confirming installation of CTSActivity Java
Method to confirm a successful installation.
Confirming installation of CTS Activity Java Method
Follow this procedure to confirm CTS Activity Java Method is successfully installed.
50
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
To confirm CTSActivity Java Method is correctly installed on Windows
and UNIX:
1.
Ensure the CTSActivityTemplateMethod.class including folder
com\documentum\cts\servermethod have been copied to the following location:
•
For Windows:
C:\Documentum\dba\java_methods\com\documentum\cts
•
For UNIX:
$Documentum/dba/java_methods/com/documentum/cts/servermethod
2.
3.
Ensure the ctsTransform.jar files have been copied to the following location:
•
For Windows: C:\Documentum\jboss4.2.0\server\DctmServer_
MethodServer\deploy\bpm.ear\bpm.war\WEB‑INF\lib
•
For UNIX: $DOCUMENTUM_SHARED/jboss4.2.0/server/DctmServer_
MethodServer/deploy/bpm.ear/bpm.war/WEB‑INF/lib
Ensure, the CTSActivity DAR file is installed on the global registry repository. See
Installing CTSActivity DAR file on a Windows/Unix repository with DAR Installer
Plugin, page 51.
Installing CTSActivity DAR file on a Windows/Unix repository with DAR
Installer Plugin
After you install the CTS Java Method and before you use the CTS Activity Template you
must install the CTSActivity DAR file on each repository.
The CTSActivity DAR file is installed in the same way as the CTS DAR files, using
headless Composer and the DAR Installer Plugin. See Installing CTS DAR files, page
44 for the complete procedure.
The DAR Installer requires you to fill in certain values that are marked with an asterisk
(*). All other fields are optional. See Table 7, page 52.
To install CTSActivity DAR file on a Windows/Unix repository with DAR
Installer Plugin:
1.
Log in to a Windows machine on which Documentum Headless Composer is
installed.
2.
Copy the CTSActivity.zip file from the distribution file to a temporary location
on the computer.
3.
Unzip the file to a temporary directory.
A subdirectory called CTS Activity Template is created and the DAR file archive is
unzipped to the new subdirectory.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
51
Installing Advanced Document Transformation Services
4.
Open the DAR Installer Program, darinstaller.exe. It is located in your Composer
installation directory.
5.
In the DAR Details section, specify values for the fields for the DAR file you are
installing.
6.
In the Connection Broker Details section, specify Connection Broker Host and
Connection Broker Port values that project to the Windows/UNIX repository. Click
Connect.
7.
In the Repository Details section, specify values for the fields and click Install to
install the DAR file to the repository.
After installing the DAR file on all required repositories, you must validate and install the
CTS Activity Template on Documentum Process Builder.
Table 7. Description of DAR Installer Fields (CTS Activity Template)
52
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
Yes
The port of the Connection
Broker Repository
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
Parameter
Required
Description
Repository
Yes
The name of the repository
that you want to install
the DAR file to. Click on
the Connect button after
entering the Docbroker
host and port to retrieve
the available repositories.
User Name
Yes
The login name for the
repository
Password
Yes
The password for logging
into the repository
Domain
No
The domain where the
repository resides
Validating and installing CTS Activity Template
As described in the Documentum Process Builder User Guide, activity templates have three
possible states: draft, validated, and installed. An activity template in the draft state has not
been validated since it was created or last modified. A template in the validated state has
passed the server’s validation checks, which ensure that the template is correctly defined.
A template in the installed state is ready to use for creating activities. The current state of
an activity template is indicated on the template icon in the palette.
You can validate your open template only if it is in the draft state and you have Write
permission.
An activity template must be installed before it is available for creating activities. You
can only install an activity template if it is in the validated state, and you have Write
permission.
To validate and install CTS Activity Template on Documentum Process
Builder:
1.
Launch Documentum Process Builder.
2.
Log in to the repository to which you have installed the DAR file.
3.
Select CTSActivity tab.
4.
Select Tools > Activity Templates > Validate. Confirm that the CTS Activity
Template has been validated:
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
53
Installing Advanced Document Transformation Services
•
If the validation is successful, a red check mark appears next to the activity
template icon in the palette.
•
If validation fails, a dialog box appears telling you so. Click the Details button to
see the error that prevented validation.
Note: If the Validate option is grayed out, it means the template is currently
validated or installed.
5.
Select Tools > Activity Templates > Install.
•
If the installation is successful, an arrow appears next to the activity template
icon in the palette.
Note: If the Install option is grayed out, it means the template is currently installed.
6.
Repeat steps 1 through 5 for each Documentum repository in which you plan to
use the CTS Activity Template.
The CTS Activity Template is now validated and installed. The installation procedures
for the CTS Activity Template are now complete.
Post‑installation tasks are provided in the Advanced Document Transformation Services
Administration Guide.
Consult the Documentum Process Builder User Guide for additional information.
Installing Branch Office Caching Services
The following section outlines the procedures required to install BOCS and configure to
the global registry.
To install Branch Office Caching Services:
1.
Download the compressed distribution file to a temporary location on the BOCS
server host.
2.
Extract the file.
a.
On Windows, double‑click the file.
b. On UNIX and Linux, untar the file:
% tar ­xvf filename
3.
Start the installation program.
•
54
On Windows, double‑click the file named bocsWinSuiteSetup.exe.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
•
On UNIX and Linux, type
% bocsoperatingsystemSuiteSetup.bin
where operatingsystem is the operating system on which you are installing, and
press Enter.
The Setup program starts and a Welcome dialog box is displayed.
4.
Read the information on the dialog box and click Next.
The installer verifies operating system requirements. The license agreement dialog
box is displayed.
5.
Accept the license terms, and click Next.
The Enter JBoss Server Info dialog box appears.
6.
Provide information for the JBoss servers.
Two instances of the JBoss servers are created, Admin Server and one to which
BOCS is deployed.
a.
Type in a password for the user ’JBoss’.
b. To use a port for the Admin Server that is different from the default, type in a
port number for the Admin Server port.
The default is 7001.
c.
To use an instance port number that is different from the default, type in a port
number for the instance port. (This is the JBoss server instance to which the
BOCS server is deployed.)
The default is 8086.
d. Click Next.
On Windows hosts, the Enter Install Owner Password dialog box appears.
7.
If you are installing on a Windows host, type the installation owner’s password,
and click Next.
The installation owner is the user who is conducting the installation procedure.
The Specify BOCS options dialog box appears.
8.
Specify the location and maximum sizes of the content caches:
a.
To choose a directory for the Cache directory that is different from the default,
use Browse.
The Cache directory is the directory where cached content is held.
b. To choose a maximum size for the Cache directory that is different from the
default, type the new value.
The value is interpreted as megabytes.
c.
To choose a directory for the Prime Store directory that is different from the
default, use Browse.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
55
Installing Advanced Document Transformation Services
The Prime Store directory is the directory where parked content is held.
d. To choose a maximum size for the Prime Store directory that is different from the
default, type the new value.
The value is interpreted as megabytes.
e.
Click Next.
A dialog box appears to allow you to enable pull mode for the connection to DMS.
9.
If the BOCS server will operate in pull mode, enable pull mode:
a.
Select Enable Pull Mode.
More fields appear on the dialog box.
b. Type the URL that the BOCS server will use to connect to DMS
In pull mode, BOCS servers take messages from DMS. The URL must be in
the following format:
http://host:port
where host is the host of the DMS server and port is the port on which the DMS
server is listening.
c.
Type the name of the bocs config object.
Record the name you select for later use when actually creating the bocs config
object. The name is recorded in the acs.properties file by the installation
program. If you use a different name when creating the bocs config object, you
must edit the acs.properties file to change the name.
d. Record the Path to Certificate value that is displayed.
This directory path will be required later, when the bocs config object is created.
e.
Click Next.
The Proxy Settings dialog box appears.
10. Indicate whether a proxy server will be installed between BOCS and Content Server.
a.
If no proxy server will be installed, select No.
b. If a proxy server will be installed:
i.
Select Yes.
ii. Specify the proxy server’s host name.
iii. Specify the port used to contact the proxy server.
c.
Click Next.
The Administration dialog box appears.
11. If the BOCS server will operate in push mode, click Next without providing a URL.
56
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
A Warning dialog box appears, telling you that pull mode is disabled for the BOCS
server. Click OK. The Administration dialog box appears.
12. Specify the password for the bocsAdmin user, and click Next.
The URL displayed on the Administration dialog box is the URL needed to create the
resource agent in Documentum Administrator for BOCS. The URL is also displayed
on the Summary dialog box and written to the install log file. Be sure to record that
URL for use in Documentum Administrator when creating the BOCS resource agent.
A Summary dialog box appears, listing the components that will be installed and
where each will be installed and the URL to for administration resource agent.
13. Click Next to start the installation.
A status dialog box appears to track the progress of the installation process.
14. Click Finish.
15. Using Documentum Administrator, create a configuration object for the BOCS in
the global registry.
Use the instructions in the online Help system for Documentum Administrator.
Installation troubleshooting
This section provides information on troubleshooting a Advanced Document
Transformation Services installation. Consult the Advanced Document Transformation
Services Release Notes for information regarding other items that can affect installation
and configuration.
Cannot pass SuperUser and repository user information
screen
When you configure Advanced Document Transformation Server, you must provide
the name and password for a repository SuperUser to allow Advanced Document
Transformation Server to access the repository. You must also provide the name of the
repository user who will receive notifications from Advanced Document Transformation
Server.
If the user information you provide is incorrect, you will not be able to configure
Advanced Document Transformation Server. Contact the repository administrator to
verify that the SuperUser exists, that you are using the appropriate password, and that
the notification user exists.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
57
Installing Advanced Document Transformation Services
If Advanced Document Transformation Server
installation fails
If you receive notification that the Advanced Document Transformation Server
installation has failed, check the Installer log file. By default, the log file (log.txt)
is located in the Advanced Document Transformation Server installation directory
(%CTS_HOME%).
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
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 machine’s locale to the repository.
The locale setting can be changed using DQL.
Configuring for WordPerfect version 10 or 11
By default, the WordPerfect plug‑in configuration file specifies the version 12 executable.
If you are using WordPerfect version 10 or version 11, you must modify the config file
accordingly. Only one executable can be specified in the config file at a time.
If the plug‑in config file does not specify the correct executable version, the executable
will fail to shut down after performing a WordPerfect transformation.
58
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Installing Advanced Document Transformation Services
To modify the WordPerfect executable in the plug­in config file:
1.
Open the wordperfect.xml file (located in %CTS_HOME%\config\wordperfect) in
a text editor.
2.
Locate the PROCESS_NAME tag.
3.
Change the process name from wpwin12.exe to either wpwin10.exe or wpwin11.exe,
so that it matches the version of WordPerfect installed on the host.
4.
Save and close the wordperfect.xml file.
5.
Restart Advanced Document Transformation Services.
The WordPerfect plug‑in will now invoke the correct executable.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
59
Installing Advanced Document Transformation Services
60
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Chapter 4
Verifying, Expanding, Removing, and
Uninstalling Advanced Document
Transformation Services
This chapter explains how to verify an installation of Advanced Document Transformation Services.
It also explains how to expand your Advanced Document Transformation Services installation by
adding instances of the Advanced Document Transformation Server. The process for removing a
Advanced Document Transformation Server instance is also explained. Procedures for uninstalling
the Advanced Document Transformation Server and the Content Transformation Services component
are provided in this chapter.
This chapter contains the following sections:
•
Verifying the Advanced Document Transformation Services installation, page 61
•
Expanding Advanced Document Transformation Services, page 63
•
Removing the Advanced Document Transformation Server instance from a repository, page 64
•
Uninstalling Advanced Document Transformation Services, page 65
•
Uninstalling Content Transformation Services, page 66
•
Uninstalling the CTS Activity Template from a Windows host, page 67
•
Uninstalling the CTS Activity Template from a UNIX host, page 68
Verifying the Advanced Document
Transformation Services installation
This section describes how to verify that you have successfully installed Advanced
Document 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.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
61
Verifying, Expanding, Removing, and Uninstalling Advanced Document Transformation Services
•
Import a test file to the repository using a Documentum client that uses Advanced
Document Transformation Services, such as Digital Asset Manager (DAM) or Web
Publisher.
Both tests are recommended. This will ensure your Advanced Document Transformation
Services installation is working correctly.
Verifying startup of Advanced Document
Transformation Services
Once Advanced Document Transformation Server is installed and configured for a
repository, Advanced Document Transformation Services should start automatically.
To verify startup of Advanced Document Transformation Services:
1.
Log in to the Advanced Document Transformation Server host as an administrator
user.
2.
Select Windows > Administrative Tools > Services to access the Windows Services
utility.
3.
Ensure that Documentum Content Transformation Services is started.
Verifying installation using DAM or Web Publisher
Once Advanced Document Transformation Services is installed, you can use Digital Asset
Manager (DAM) or Web Publisher to verify that Advanced Document Transformation
Server is performing transformations correctly.
To verify a Advanced Document Transformation Server installation using
DAM or Web Publisher:
62
1.
Use DAM or Web Publisher to import a document or browse for a document in an
applicable source file format.
2.
Select the file.
3.
Transform the document to PDF or HTML. Use both the Transform to PDF/HTML
action, and the Transformation using Profiles action. For more information on how to
perform transformations, see the DAM or Web Publisher User Guide or online help.
4.
If Advanced Document Transformation Server is installed and running successfully,
DAM or Web Publisher will perform the requested transformation and the new
rendition will appear in the object’s list of renditions.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Verifying, Expanding, Removing, and Uninstalling Advanced Document Transformation Services
Expanding Advanced Document
Transformation Services
If you wish, you can add more than one Advanced Document Transformation Server
configuration to your system. For more information on scalability, see Content
Transformation Services scalability, page 10.
Configuring Advanced Document Transformation
Server for another repository
This section describes how to configure a Advanced Document Transformation Server
against another repository. You can run one installation of Advanced Document
Transformation Server on a single host and have it configured against multiple
repositories.
This procedure does not perform the base installation or install configuration files, which
must be done only once (see Installing Advanced Document Transformation Server,
page 38). You do not need to rerun the entire installation procedure to apply Advanced
Document Transformation Services to an additional repository. It is only necessary to
add an instance of the Advanced Document Transformation Server.
Caution: Ensure the appropriate Connection Broker and repositories are running
before continuing with the configuration.
To configure an instance of Advanced Document Transformation Server:
1.
Navigate to the Advanced Document Transformation Services Configurator under
Start > Programs > Documentum >ADTS Configuration Utility.
The Advanced Document Transformation Services Configurator splash screen is
displayed, followed by the Welcome screen.
2.
Click Next.
The license agreement terms are displayed.
3.
Select the option to accept the terms of the license agreement, then click Next.
4.
Select Add a Advanced Document Transformation Server instance to a repository,
and click Next.
5.
Enter the name of the Advanced Document Transformation Services host. The
Configurator may detect the host name for you. This will be the name of the machine
on which you have installed Advanced Document Transformation Server.
Click Next.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
63
Verifying, Expanding, Removing, and Uninstalling Advanced Document Transformation Services
6.
A list of the repositories served by your Connection Broker appears. For
instructions on selecting a Connection Broker, see Identifying a Connection Broker in
dfc.properties, page 27. Select a repository to be served by the Advanced Document
Transformation Server and click Next.
7.
The User Information screen appears.
Enter the SuperUser name that Advanced Document Transformation Server will use
to access the repository. (Do not use dm_mediaserver.)
Enter the password for the SuperUser account, and re‑enter it to verify.
Enter the name of the repository user who will receive notifications from Advanced
Document 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 Advanced
Document Transformation Server installation information, page 35 for details
regarding values for these fields.
Click Next.
If you cannot continue, check with the repository administrator to verify that the
users exist and that you entered the correct password in both fields.
8.
If the repository you have chosen is in a distributed environment, a screen will
appear with a list of Content Servers configured for the repository you have chosen
to configure with Advanced Document Transformation Services.
Select a Content Server from the list and select Process local content only.
For more information on Distributed Content Servers and the distributed
environment, see the Documentum Distributed Configuration Guide.
9.
A dialog box indicates the success of the Advanced Document Transformation
Server configuration.
Click Finish.
This additional repository is now configured for Advanced Document Transformation
Services.
Removing the Advanced Document
Transformation Server instance from a
repository
This section describes how to remove an instance of Advanced Document Transformation
Server from a repository. This procedure does not remove the configuration files and
services associated with Advanced Document Transformation Server. To remove the
64
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Verifying, Expanding, Removing, and Uninstalling Advanced Document Transformation Services
Advanced Document Transformation Server from a host, see Uninstalling Advanced
Document Transformation Services, page 65.
To remove an instance of Advanced Document Transformation Server from
a repository:
1.
Navigate to the Advanced Document Transformation Services Configurator under
Start > Programs > Documentum >ADTS Configuration Utility.
The Advanced Document Transformation Services Configurator splash screen is
displayed, followed by the Welcome screen.
2.
Click Next.
The license agreement terms are displayed.
3.
Select the option to accept the terms of the license agreement, and click Next.
4.
Select Remove a Advanced Document Transformation Server instance from a
repository and click Next.
5.
Select the repository from which you want to remove the Advanced Document
Transformation Server, and click Next.
The User Information screen appears.
6.
Enter the SuperUser name that Advanced Document Transformation Server uses
to access the repository.
7.
Enter the password for the SuperUser account.
8.
Click Next.
If you cannot continue, check with the repository administrator to verify that the
user exists and that you entered the correct password.
9.
The instance of Advanced Document Transformation Server is removed.
A dialog box indicates the success of the Advanced Document Transformation
Server removal.
10. Click Finish.
The instance of Advanced Document Transformation Server is now removed from the
repository.
Uninstalling Advanced Document
Transformation Services
This section describes how to uninstall Advanced Document Transformation Server
from a Windows host. The Uninstaller removes all folders and the files contained
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
65
Verifying, Expanding, Removing, and Uninstalling Advanced Document Transformation Services
within those folders. Files that are in use are marked for deletion and removed when
the system is restarted.
To remove only an instance of Advanced Document Transformation Services, follow the
instructions in Removing the Advanced Document Transformation Server instance
from a repository, page 64.
Caution: It is strongly recommended that you remove all instances of Advanced
Document Transformation Services configured for repositories, prior to uninstalling
Advanced Document Transformation Server.
To uninstall Advanced Document Transformation Server:
1.
Log in as an administrator user to the machine on which Advanced Document
Transformation Server is installed.
2.
Ensure that no programs or applications are running.
3.
Click Start > Settings > Control Panel and double‑click Add/Remove Programs.
4.
In the Change or Remove Programs window, select Documentum Advanced
Document Transformation Server and click Change/Remove.
The uninstaller for Advanced Document Transformation Server opens and displays
the Welcome screen.
5.
Click Next.
6.
The location from which Advanced Document Transformation Server will be
removed is displayed. Click Next.
The Content Transformation Services service stops and Advanced Document
Transformation Server is uninstalled.
7.
Restart the computer if prompted to do so. This deletes any Advanced Document
Transformation Server files that may have been in use. This is especially important if
you are going to reinstall Advanced Document Transformation Server on the host.
Uninstalling Content Transformation Services
If you are uninstalling all Content Transformation Services products (Document
Transformation Services, Advanced Document Transformation Services, Advanced
Document Transformation Services, Media Transformation Services) from your host,
then you will also need to uninstall the common Content Transformation Services
component. This provides a clean host on which to install other products, or to reinstall a
Content Transformation Services product.
66
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Verifying, Expanding, Removing, and Uninstalling Advanced Document Transformation Services
To uninstall Content Transformation Services:
1.
Log in as an administrator user to the machine on which Content Transformation
Services is installed.
2.
Ensure that no programs or applications are running.
3.
Click Start > Settings > Control Panel and double‑click Add/Remove Programs.
4.
In the Change or Remove Programs window, select Documentum Content
Transformation Services and click Change/Remove.
The Uninstaller for Content Transformation Services opens and displays the
Welcome screen.
5.
Click Next.
6.
The location from which Content Transformation Services will be removed is
displayed. Click Next.
The Content Transformation Services service stops and Content Transformation
Services is uninstalled.
7.
Restart the computer if prompted to do so. This deletes any files that may have
been in use. This is especially important if you are going to reinstall a Content
Transformation Services product on the host.
Uninstalling the CTS Activity Template from a
Windows host
This section describes how to uninstall the CTS Activity Template from a Windows host.
Caution: Do not uninstall DFC prior to uninstalling CTS Activity Template Services.
To uninstall CTS Activity Template from the Control Panel:
1.
On the host machine, click Start > Settings > Control Panel and double‑click
Add/Remove Programs.
2.
In the Change or Remove Programs window, locate the Documentum CTS Activity
Template for BPM program, select it, and click Change/Remove.
3.
In the Change/Remove dialog box, click Next.
The UninstallShield Wizard welcome screen appears.
4.
Click Next.
5.
Click Next again.
The uninstall proceeds.
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
67
Verifying, Expanding, Removing, and Uninstalling Advanced Document Transformation Services
6.
When the uninstall is complete, you will receive notification from the uninstaller.
click Finish
The CTSActivity Java Method is now uninstalled.
Uninstalling the CTS Activity Template from a
UNIX host
This section describes how to uninstall the CTS Activity Template from a UNIX host.
Caution: Do not uninstall DFC prior to uninstalling CTS Activity Template Services.
To uninstall CTS Activity Template from a UNIX host using the Uninstall
Wizard:
1.
On the host machine, navigate to the directory called _uninst in the root location of
the install (for example, $DOCUMENTUM/_uninst).
2.
Open the ctsActivity folder.
3.
In a command window, run the file ./uninstall.bin.
The Uninstall Wizard launches and the Welcome screen appears.
4.
Click Next.
A dialog box appears detailing the DAR file name and target repository.
5.
Click Next.
The installation process continues.
6.
Follow the prompts to remove CTS Activity Template from the appropriate
application server.
7.
Click Finish to close the uninstaller.
The CTSActivity Java Method is now uninstalled.
68
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Index
A
B
adding
an ADTS instance, 34, 63
repository to ADTS, 63
admin user, 36
Advanced Document Transformation
Server
adding repositories to, 63
configuration, 41, 47
domain user, 37
expanding, 34
installation, 35, 61
installation directory, 36
notifications, 37
pre‑installation verifications, 27
reinstalling, 27, 34
removing instances, 64
software prerequisites, 26
troubleshooting, 58
uninstalling, 27
Advanced Document Transformation
Services
architecture, 11
description, 11
environment, 11
error messages, 37
expanding, 63
features, 16
how it works, 14
installation, 34
rendering applications required, 33
requirements, 13
uninstalling, 65
AFPL Ghostscript, 21
applications required, 33
architecture, 11
ASP.Net, 26, 32
AutoRender Pro, 27, 31
BOCS
installing, 54
C
checked out documents, 11, 14 to 15
Configurator, 34
configuring, 41, 47
Connection Broker
checking services, 28
host, 35
identifying in dfc.properties, 27
Content Rendition Services, 27, 31
Content Server, 25
Connection Broker, 28
repositories, 28
Content Transformation Server
installation, 38
Content Transformation Services
description, 9
extending, 13
format awareness, 10
queue, 10
scalability, 10
uninstalling, 66
Corel WordPerfect, 21
using version 10 or 11, 58
CTS Activity Template
CTSActivity DAR, 51
installation, 48
installing and validating , 53
uninstalling, 67
working with, 22
CTS DAR
installing, 44
cts_instance_info, 58
D
DAM
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
69
Index
using DFC, 12
verifying ADTS installation, 62
DAR
installing, 44
DFC, 34
about, 12
and dfc.properties, 27
directories, 35
installing, 12, 38
migrating, 13
dfc.properties, 27
Digital Asset Manager, see DAM
dm_queue, 15
documents, checked out, 11, 14 to 15
Documentum Foundation Classes, see
DFC
Documentum Process Builder
installing and validating CTS Activity
Template, 53
domain name, 37
E
expanding ADTS, 63
F
failed installation, 27, 34, 58
FAST Server, 25
formats
input (source), 19
output (target), 19
supported as source for HTML, 19
supported as source for PDF, 19
Full Text Index Server, 25
HTML renditions, 11, 15
HyperText Markup Language, see HTML
renditions
I
IIS (Internet Information Services), 26, 32
Informative Graphics Myriad, 21
input formats, 19
installation, 54
CTSActivity DAR, 51
directory, 35 to 36
failure, 58
of Advanced Document
Transformation Server, 35,
38
overview, 34
plug‑ins, 13
prerequisites, 25 to 26
procedure, 38, 48
troubleshooting, 57
verifying, 61 to 62
Installation
profile migration dialog box, 22
installers, 30
installing, 44
BOCS, 54
CTS Activity Template, 51
of CTS Activity Template, 48
installing and validating CTS Activity
Template
Documentum Process Builder, 53
instance
adding, 63
configuring, 41
removing, 64
G
J
Ghostscript, 21
global registry, 38
DAR files, 47
enabling, 43
user name, 38
Java components, 34
L
H
headless Composer, configure, 45
headless Composer, install, 26, 45
host, 36
preparing, 29
selecting, 25
70
locale setting, 58
locked documents, see documents,
checked out
log file, 58
M
Microsoft
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Index
Excel, 21
Outlook, 21
PowerPoint, 21
Project, 21
Visio, 21
Word, 21
migration of DFC, 13
MSMQ (Microsoft Message Queue), 26, 32
Myriad, 16, 21
N
.NET Framework, 26, 32
O
objects, 14, 16
operating system, 26
output formats, 19
P
PDF renditions, 14
plug‑ins
adding, 13
description, 13
installation of, 13
role in Advanced Document
Transformation Services, 12
standard, 13
port for CTS Admin, 37
Portable Document Format, see PDF
pre‑installation tasks, 29 to 30
Print Spooler service, 31
profiles
migrate, 30
Q
queue
objects, 12
removing unsupported formats
from, 10
R
removing an instance, 64
repository, 64
checking, 28
SuperUser, 36
user, 37, 57
requirements
installation, 35
software, 26
S
scalability of Content Transformation
Services, 10
selecting server host, 25
software prerequisites, 26
source documents, 19
source formats, 19
startup, verifying, 62
SuperUser, 36, 42, 57
system architecture, 11
T
target formats, 19
transformations, 12
troubleshooting, 57 to 59
installation failure, 27, 34, 58
user information screen, 57
U
uninstalling
Advanced Document Transformation
Server, 27, 65
Content Transformation Services, 66
CTS Activity Template, 67
previous Documentum products, 31,
34
user
admin, 36
repository, 36
troubleshooting, 57
V
verifying
installation, 61
pre‑installation, 27
startup, 62
W
WDK, 12
Web Development Kit, see WDK
Web Publisher, 62
Windows Service, 10, 62
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
71
Index
WordPerfect
using version 10 or 11, 58
72
Z
Zip files, 15
EMC Documentum Advanced Document Transformation Services Version 6.5 Installation Guide
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising