EMC Documentum Content Transformation Services Transformation Suite

Transcription

1 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Legal Notice Copyright EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at ECD.Documentation.Feedback@emc.com.

3 Table of Contents Preface... 7 Chapter 1 Installing Content Transformation Services products... 9 Pre-installation configuration... 9 Software prerequisites Selecting the server host Downloading installers Verifying the connection broker Updating a Connection Broker in dfc.properties Checking Connection Broker and repository services Setting the locale of the repository and host Installing Microsoft fonts Required installation information Providing required permissions to the Content Transformation Services install user Installing Content Transformation Services Installing Content Transformation Services DAR files Configuring Headless Composer Installing a DAR file with DAR Installer Plug-in Content Transformation Services product installation Configuring an instance of a Content Transformation Services server Content Transformation Services products silent installation and configuration Post-installation tasks Enabling a Document Foundation Classes installation to access a global registry Configuring Content Transformation Server for another repository Enhancing memory availability for Content Transformation Services Chapter 2 Verifying Content Transformation Services Installation Verifying Content Transformation Services installation Verifying startup of Content Transformation Services service Chapter 3 Unconfiguring and Uninstalling Content Transformation Services Unconfiguring Content Transformation Services Unconfiguring a Content Transformation Services instance manually Unconfiguring Content Transformation Services instance in the silent mode Uninstalling Content Transformation Services products Chapter 4 Upgrading Content Transformation Services Upgrading Content Transformation Services Backing up and removing old profiles Viewing log file of migrated profiles EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 3

4 Table of Contents Chapter 5 Deploying CTS WebServices Deploying CTS WebServices on Windows JBoss Deploying CTS WebServices on VMware vfabric tc Server Deploying CTS WebServices on Oracle Weblogic Deploying CTS WebServices on Apache Tomcat Deploying CTS WebServices on IBM WebSphere Chapter 6 Installation Troubleshooting Troubleshooting tips for Content Transformation Services Checking the installer log file If cts_instance_info object is not created when the Configurator is executed A Transformation DAR error occurs when upgrading from a previous version Deleting log files Third-party applications installed on the Content Transformation Services host should not be used by any other products or users Uninstalling or reinstalling Content Transformation Services Content Transformation Services Configurator cannot be configured to the Japanese, Korean, or Simplified Chinese repository Chapter 7 Installing the Language Pack Installing an Content Transformation Services Language Pack Enabling multilingual support in Content Transformation Services EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

5 Table of Contents List of Tables Table 1. Common requirements for Transformation Services Table 2. Required installation information Table 3. Description of DAR Installer Fields (Content Transformation Services DAR) EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 5

6 Table of Contents 6 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

7 Preface This guide provides installation prerequisites and step-by-step procedures for installing the Content Transformation Services (CTS) products. Content Transformation Services is a suite of Documentum server products that perform transformations and analysis on repository content. The Content Transformation Services functionality is available through Documentum client applications. Content Transformation Services consists of these products: CTS Documents CTS Media CTS Audio-Video XML Transformation Services (XTS) EMC Documentum Content Transformation Services Transformation Suite Administration Guide provides the brief overview of Content Transformation Services architecture. Intended audience This guide is intended for the person who installs and configures the Content Transformation Services products, often called the system administrator or system operator. It is assumed that the system operator has a basic understanding of the Windows operating system. Revision history The following changes have been made to this document. Revision Date November 2016 Description Initial publication. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 7

8 Preface 8 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

9 Installing Content Transformation Services products Chapter 1 This chapter describes the process of installing Content Transformation Services products on a Windows host. Content Transformation Services runs as a Windows Service on the Content Transformation Services host. Post-installation tasks, configuration tasks, and troubleshooting information are also provided in this document. Pre-installation configuration, page 9 Installing Content Transformation Services, page 15 Post-installation tasks, page 24 Content Transformation Services allows for a high level of scalability. Multiple Content Transformation Services instances can be configured to a single repository. If you have one installation of Content Transformation Services on a host, the same installation can be configured against different repositories. Note: Ensure that you cleanup the previous versions of Documentum Foundation Classes (DFC) before installing Content Transformation Services products. Pre-installation configuration Ensure that the following requirements are met before you install Content Transformation Services: Software prerequisites, page 10 Selecting the server host, page 11 Downloading installers, page 11 Verifying the connection broker, page 12 Setting the locale of the repository and host, page 12 Installing Microsoft fonts, page 13 Required installation information, page 13 Providing required permissions to the Content Transformation Services install user, page 15 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 9

10 Installing Content Transformation Services products Software prerequisites This section provides information about the software that is required or optional for Content Transformation Services. The following software must be installed, configured, and running properly on your network before you install Content Transformation Services: Documentum Content Server Before installing Content Transformation Services, you must install several applications and other components on the server host (or another machine, where applicable). Table 1, page 10 provides details about the software that must be installed, configured, and running properly on the host (or another machine, whichever applicable) before you install Content Transformation Services. Table 1. Common requirements for Transformation Services Supporting Software / Rendering Applications Documentum Composer/DAR Installer Microsoft Windows as the operating system. Required/ Optional Required Required Notes To install DAR files. Does not have to be installed on the Content Transformation Services host, but must be able to access Content Transformation Services repositories. Documentum Administrator Optional To access Content Transformation Services administration features. GhostScript Note: The EMC E-LAB Interoperability Navigator contains information about the supported version. Optional Allows the Doc3 plug-in to process PostScript files. Allows the Image3 plug-in to process all PostScript source and target formats such as EPS, PS, AI, and PDF. Microsoft PowerPoint Optional Required by PowerPoint2 plug-in for the generation of thumbnails, low-resolution renditions, storyboards, and slide objects from PowerPoint files. Microsoft Word, Microsoft PowerPoint, Microsoft Excel Optional Required by Doc10 plug-in for high fidelity Word, PowerPoint, or Excel to PDF transformations. Arial Unicode Font Optional To support extended multi-byte character range in documents (Chinese, Japanese, Korean, Arabic, and so on). Microsoft HTML Help Workshop Optional Used for transforming XML files to CHM. This application must be installed with all options. 10 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

11 Installing Content Transformation Services products Note: Ensure that all applications are installed in their default locations. Content Transformation Services refers to each application s default installation directory while launching an application. Some applications provide you with the choice of installing them with minimal or full options. Applications installed with minimal options may not run correctly with the Content Transformation Services product. Selecting the server host Follow these basic guidelines for selecting the host machine for your Content Transformation Services installation. The server name must not, and cannot exceed 15 bytes. The server must have a 6 GB System RAM (or higher capacity). The Content Transformation Server requires a 4 GB RAM for file manipulations. In addition, if the expected file size to be processed is very large then an equivalent memory allowance must be provisioned. For example, if the largest file expected is 1 GB, then the Content Transformation Server requires an extra 1 GB RAM (4GB + 1GB). Enhancing memory availability for Content Transformation Services, page 25 provides instructions on how you can increase the RAM for Content Transformation Services. Caution: To ensure optimal system performance, do not install the Content Transformation Services product on the same host as Content Server or xplore. This configuration is not certified, supported, or recommended. Downloading installers Before beginning the installation process, it is recommended to download the installers on your Content Transformation Services host. You can download the installers from the EMC Online Support CTS-DocumentsWinSetup.exe CTS Documents CTS-MediaWinSetup.exe CTS Media CTS-Audio-VideoWinSetup.exe CTS Audio-Video xtswinsetup.exe XTS The ZIP file contains the executable installer file, silent installer batch files, and configuration files. Extract the ZIP files into a temporary folder before you proceed with the installation. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 11

12 Installing Content Transformation Services products Verifying the connection broker Prior to installation, verify the following: If you already have a dfc.properties file, it is pointing to the correct Connection Broker. Updating a Connection Broker in dfc.properties, page 12 provides the required instructions. The Connection Broker and repository services are running on your Content Server. Checking Connection Broker and repository services, page 12 provides the required instructions. Updating a Connection Broker in dfc.properties If you already have Documentum Foundation Classes installed on the Content Transformation Services host server, you will have a dfc.properties file. This procedure is to ensure that the correct Connection Broker is specified. If you are installing Content Transformation Services on a clean host, you will not have a dfc.properties prior to installation. In such a scenario, the following procedure is not required. EMC Documentum Content Server Administration and Configuration Guide provides more information about the Connection Broker. Updating Connection Broker in dfc.properties 1. Search for the dfc.properties file on your Content Transformation Services host server. The file is usually located in the Windows (C:\Documentum\config) folder. 2. Open dfc.properties in a text editor. 3. Find the line indicating the Connection Broker. Ensure that the specified Connection Broker is the one that contacts the repository. Change it if necessary. 4. Save and close the dfc.properties file. Checking Connection Broker and repository services The Connection Broker and repository services must be running correctly on the Content Server host before you install Content Transformation Services. Setting the locale of the repository and host The locale setting of the repository and the Content Transformation Services host server must be the same before installing Content Transformation Services. If it is not, the cts_instance_info table is not created in the repository. For example, install Content Transformation Services on a server where the locale is set to en and configure Content Transformation Services for a repository with locale set to en. 12 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

13 Installing Content Transformation Services products Installing Microsoft fonts Fonts used in source files like Microsoft Word, Excel, or PowerPoint should be present in the Content Transformation Services server host to get the right target PDF renditions. Otherwise, the original fonts are replaced with alternate fonts in the resultant PDF rendition. Note: The Arial Unicode MS font must be installed to support double-byte characters. The Microsoft website provides the instructions required to install and uninstall Microsoft fonts. Required installation information The table in this section allows you to record the information you need to install a Content Transformation Services server. Table 2. Required installation information Installation information Description Your value Document Foundation Classes installation directory This is the destination directory for Document Foundation Classes. Connection Broker host name (if not detected) Content Transformation Services server installation directory The default directory is C:\Documentum. If the correct Document Foundation Classes has not yet been installed on the host, you will be prompted during installation for the primary Connection Broker host name and Docbroker port number that is servicing the repository you want to configure with Content Transformation Services. The directory in which to install the Content Transformation Services server. It is recommended that you use a subdirectory of the directory in which other Documentum products are installed. For example, if other Documentum products are installed in D:\Documentum, use the same path for Content Transformation Services EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 13

14 Installing Content Transformation Services products Installation information Description Your value Content Transformation Server host (if not detected) Admin User name and password Repository SuperUser name and password Notification user name installation. The installer will create a subdirectory called "CTS. The name of the machine on which you are installing Content Transformation Server. You may need to enter this information if it is not automatically detected by the installer, or if you are running the installer from a remote computer. The name of the admin user who is installing the Content Transformation Services server. The account the Content Transformation Server uses to log in to the repository. Ask your administrator to supply you with a SuperUser name and password. The name of the user who will receive notifications from Content Transformation Server. Content Transformation Services Admin Port CTS WebServices Port Content Transformation Services notifies the user of the results of processing. For example, if Content Transformation Server fails to process a particular item, it queues an event to the Inbox of the Content Transformation Server system operator user (sysopuser). The port used by Documentum Administrator to communicate with the Content Transformation Services installation. The default is The port is used for WebServices communication. The default is EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

15 Installing Content Transformation Services products Installation information Description Your value Domain name Global registry dm_bof_registry The name of the domain used to authenticate the user. Use the fully-qualified domain. Different Document Foundation Classes installations can use different global registries where required service-based objects or network locations are stored. A single Document Foundation Classes installation can have only one global registry. You will be prompted during installation for the primary registry. 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. Providing required permissions to the Content Transformation Services install user Ensure that the Content Transformation Services install user has the following permissions: 1. The install user has Administrator privileges. 2. The install user is part of the Windows local Administrator group. 3. Add the install user to the Log on as a service policy under Local Security Policy > Local Policies > User Rights Assignment. 4. The install user has full permissions to the installation directory. Installing Content Transformation Services Ensure that the installation user account has Administrator privilege and that the installation user account is included in the local Administrators group. Else, the Content Transformation Services product installation fails. Note: If you are reinstalling Content Transformation Services, you must first uninstall the previous version of the product that is installed on your server. Refer to Unconfiguring Content Transformation Services, page 29. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 15

16 Installing Content Transformation Services products Content Transformation Services installation is accomplished as a four-step process: 1. Install Content Transformation Services DAR files. Installing Content Transformation Services DAR files, page 16 describes the process of installing Content Transformation Services DAR files. 2. Install Content Transformation Services. You can install Content Transformation Services using one of the following installers: Installer Content Transformation Services product installation, page 19 describes the process of installing Content Transformation Services using the installer. Silent Installer Content Transformation Services products silent installation and configuration, page 22 describes the process of installing Content Transformation Services using the Silent Installer. 3. Configure the Content Transformation Services server to at least one repository. The standard configuration procedure is found at Configuring an instance of a Content Transformation Services server, page After installing the Content Transformation Services server, you can verify that your installation is running correctly. Verifying Content Transformation Services installation, page 27 explains this procedure. Installing Content Transformation Services DAR files Install Content Transformation Services DAR files before configuring Content Transformation Services to obtain all the latest changes/enhancements. Install the DAR files in the global repository and in each repository where Content Transformation Services must be configured. Install the following DAR files: Rich Media Services Transformation Content Transformation Services Aspects XTS 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. Headless Composer can be found on the Content Server host at C:\Documentum\product\<version>\install\composer\ComposerHeadless. Download and install the latest version of Headless Composer before installing the Content Transformation Services DAR files. Headless Composer is available on the EMC Online Support as part of Documentum Developer Studio. Note: You must have Superuser privileges for the repositories in which you are installing the DAR files. In Windows, disable User Account Control (UAC) and invoke the DAR installer using the Run as administrator option. 16 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

17 Installing Content Transformation Services products Configuring Headless Composer The Headless Composer zip file has the format DCTM_Headless_Composer_<platform>_<version>. zip. To configure headless Composer: 1. Extract the headless Composer Zip file to a directory of your choice on the local machine. The directory name must not contain any spaces. 2. Open the dfc.properties file at:..\composerheadless\plugins\com.emc.ide.external.dfc_ 1.00\documentum.config with a text editor. 3. Add the Document Foundation Classes and connection broker information, similar to 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 Plug-in 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 Plug-in is useful if you want to de-couple the development of DAR files from the installation of DAR files. It is also useful if installation of DAR files is required as part of a deployment process. When you open the DAR Installer program, it creates three folders in your Composer installation directory: darinstallerconfiguration - contains configuration files for the DAR Installer program darinstallerlogs - the default location of the log files darinstallerworkspaces - workspaces that are created and used by the DAR Installer program. The DAR Installer program does not delete these workspaces automatically, so you occasionally need to cleanup this directory. The workspace directories are named in the following form: darinstallerworkspaces/yyyy-mm-dd-hh-mm-ss. The DAR Installer requires you to fill in certain values that are marked with an asterisk (*). All other fields are optional. 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 and searching for "Composer to reach the Documentum Composer download site. 2. Extract the DAR Installer zip file to the root directory of the Composer or headless Composer installation directory. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 17

18 Installing Content Transformation Services products 3. Run dardeployer.exe to start the DAR Installer Plugin. The dardeployer.exe is located in the Composer root directory, or on the Content Server machine at C:\Documentum\product\<version>\install\composer\ComposerHeadless. 4. In the DAR Details section, specify values for the fields. 5. In the Connection Broker Details section, specify values for Connection Broker Host 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 3. Description of DAR Installer Fields (Content Transformation Services DAR) Parameter Required Description DAR Yes The absolute file path to the.dar file that you want to install. The file path cannot contain any I18N characters or the installation will fail. Input File No The absolute file path to the install-based parameter file Local Folder No The absolute file path to localized.properties files. If you want to make your application available in other languages, you need to localize the project data such as labels, tabs, and descriptions. Log File No The file to save the log to. If this is not specified, the file defaults to <DAR>.log Connection Broker Host Yes The address of the Connection Broker Connection Yes The port of the Connection Broker Repository Broker Port 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 Note: On a non-windows Content Server machine, use the following command to install the DAR file: java -Ddar=<darflepath> -Dlogpath=./<filename.log> -Ddocbase=<docbase> -Duser=<username> -Ddomain= -cp $DM_HOME/install/composer/ComposerHeadless/startup.jar org.eclipse.core.launcher.main -data $DM_HOME/install/composer/workspace -application org.eclipse.ant.core.antrunner -buildfile $DM_HOME/install/ composer/deploy.xml 18 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

19 Installing Content Transformation Services products Content Transformation Services product installation To install Content Transformation Services server: 1. Log in to the selected Content Transformation Server host as an administrator user. Note: Ensure that no programs or applications are running on the host. 2. Navigate to the folder containing the extracted Content Transformation Server product installation files. 3. Double-click the following file to install this version of the Content Transformation Services product. CTS-DocumentsWinSetup.exe to install CTS Documents CTS-MediaWinSetup.exe to install CTS Media CTS-Audio-VideoWinSetup.exe to install CTS Audio-Video xtswinsetup.exe to install XTS Note: Perform the installation of the Content Transformation Services products consecutively, as required. 4. Click Next. 5. Select I accept the terms of the license agreement, and then click Next. The default destination directory (C:\Documentum) for the installation of all components (CTS Framework, Content Transformation Services, and DFC) appears on the screen. 6. Change the destination directory, if required, and then click Next. To accept the default, click Next. Note: Ensure that the selected destination directory does not contain a space in its name. Document Foundation Classes is installed in the same location as Content Transformation Services. 7. Enter the hostname of the machine that will be running the Content Transformation Framework. Correct the host name if it is invalid or append the domain to create a Fully Qualified Domain Name. Click Next. 8. Enter the port number to which the Content Transformation Services Administration Agent will be configured. This port is used in conjunction with Documentum Administrator to communicate with Content Transformation Services hosts. The default port number is Modify the default port number and click Next. 9. Enter the port number to which CTS WebServices will be configured. The default port number is Click Next. Note: The installer automatically stops the Content Transformation Service if it is already present on the host. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 19

20 Installing Content Transformation Services products 10. The Installation Summary screen appears, listing the applications that will be installed. If you are satisfied with the installation confirmation, click Next. To change a component of the installation, click Previous to navigate back through the Installer and change the install information. 11. Click Done. The installation wizard closes. Configuring an instance of a Content Transformation Services server To complete the Content Transformation Services installation, configure the instance to a repository. Note: You can configure multiple Content Transformation Services instances to a repository. Caution: All the instances deployed against a repository must share the same version (including patch version) to avoid behavior conflicts between versions. Caution: Ensure that the appropriate Connection Broker and repositories are running before continuing with the configuration. To configure an instance of Content Transformation Server: 1. Select the CTS Configuration Utility located at Start > Programs. 2. Click Next. 3. Select I accept the terms of the license agreement, and then click Next. 4. Enter the host name and port number of the Primary Connection Broker. The default port number is Note: This screen appears only when you are configuring a Content Transformation Services product for the first time on a machine. 5. Select Use certificates. Click Browse to locate a valid dfc.keystore file. Enter the password for the located dfc.keystore file. Note: This step is optional and is performed only when you want to configure this Content Transformation Services instance to a docbase that is projected with a secured docbroker (certificate-based). Alternatively, you can select Use Default Java TrustStore while configuring Content Transformation Services to a secured Content Server. 6. Enter the global repository name, login name, and its password and click Next. Note: This screen appears only when you are configuring a Content Transformation Services product (or DFC) for the first time on a machine. 7. Select Add a Content Transformation Services instance to a repository, and click Next. Note: If a Content Transformation Services product has already been configured in this repository, an additional option, Remove a Content Transformation Services instance from a repository appears along with the Add a Content Transformation Services instance to a 20 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

21 Installing Content Transformation Services products repository option. If all the installed Content Transformation Services products have already been configured in this repository, only the Remove a Content Transformation Services instance from a repository appears on the screen. 8. The Configurator detects the name of the Content Transformation Server host. Correct the host name if it is invalid or append the domain to create a Fully Qualified Domain Name. 9. Click Next. The Repository Name and User Information screen appears. 10. Enter information for the repository: a. Select a repository to be served by the Content Transformation Server. b. Enter the SuperUser name that Content Transformation Server will use to access the repository. c. Enter the password for the SuperUser account. d. Enter the domain name, if applicable. This is an optional field; if you are installing from a local machine, this can be left blank. e. Enter the name of the repository user who will receive notifications from Content Transformation Server, otherwise known as the system operator. f. Select the Add Additional Domain Users check box, if you are setting up to support requests from additional domains. If you have multiple domain users in the Content Server that transform content, select this option. The installer will create an Admin user for each domain to support transformations by users of each domain. Enter credentials for a new domain and its SuperUser in the required fields. Repeat this step to include additional domains, as required. g. For performance metric reports to be generated, select Set as Performance Log Repository. 11. Click Next. If you cannot continue, check with the repository administrator to verify that the users exist and that you entered the correct password. The CTS Configuration Program screen appears. 12. Select the Content Transformation Services products (CTS Documents, CTS Audio-Video, CTS Media, XTS) that you must configure to the repository. Note: Only those Content Transformation Services products that you have already installed are listed in this screen. If only one Content Transformation Services product is installed, then this screen does not appear. 13. Click Next. The User Authentication screen appears. 14. Enter the system administrator user name and password. Click Next. The Profile Customization Report screen appears. 15. Select the previous version of Content Transformation Services configured to the repository to generate a Profile Customization Report. Note: The Profile Customization Report screen appears only when you run the Configurator for the first time after installing Content Transformation Services. 16. After you select a version, select the Content Transformation Services product that was previously configured. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 21

22 Installing Content Transformation Services products 17. Click Next. The registry updates. The Configurator migrates all old profiles automatically, if applicable. 18. A dialog box indicates the success of the Content Transformation Server configuration. Click on Profile Customization Report to open the report. If you are prompted to restart the host, do so now. Click Done. The Configurator closes. Note: The Profile Customization Report is saved at %CTS_HOME%/migration/log. Content Transformation Services products silent installation and configuration The silent installer allows you to provide all installation, repository, and global registry information in a configuration file, after which you can run the installer and configurator batch files. 1. Log in to the selected Content Transformation Server host as an administrator. 2. Ensure that no programs or applications are running on the host. 3. Navigate to the folder containing the extracted Content Transformation Server product installation files. Downloading installers, page 11 provides information about where the files should be located. 4. Locate the cts_win_install.properties file. 5. Configure cts_win_install.properties with relevant values using a text editor: ## silent install response file INSTALLER_UI=silent ####installation # Default installation location is "C:\\Documentum CTS.INSTALLATION_DIR=<CTS_INSTALLATION_PATH> # Ensure that you enter the hostname instead of the Fully Qualified Domain Name(FQDN) CTS.HOSTNAME=<CTS_HOST_NAME> CTS.ADMIN_PORT=<ADMIN_AGENT_PORT> #Default port is 9095 CTS.JETTY_PORT=<JETTY_SERVER_PORT> #Default port is 9096 INSTALL_FILES=false 6. Open the command prompt and navigate to the installer directory where the cts_win_install.properties file is available. 7. Run the installer silently from the command prompt, using this command: <PRODUCT>WinSetup.exe -f cts_win_install.properties For example, for CTS Media, the command is CTS-MediaWinSetup.exe -f cts_win_install.properties 8. Verify the installation logs created under the Logs folder in the installer directory. 9. Upon successful installation, navigate to %CTS_HOME%\server_install folder. This folder must contain the following files: cts_win_config_adding.properties and cts_win_config_removing.properties. 22 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

23 Installing Content Transformation Services products Note: The %CTS_HOME% directory refers to C:\Documentum\CTS unless changed during the installation process. 10. To configure Content Transformation Services to a docbase, update the cts_win_config_ adding.properties file with the relevant values using a text editor # Please specify the config actions, "add" or "remove". CTS.INSTALL_TYPE=add # Please specify the host name for CTS machine CTS.HOSTNAME=<CTS_HOST_NAME> # Please specify the repository name CTS.DOCBASE=<REPO_NAME> # Please specify the repository super user and password CTS.DOCBASE_SUPERUSER=<DOCBASE_SUPER_USERNAME> CTS.NOT_ENCRYPTED_PASSWORD=<DOCBASE_PASSWORD> # Please specify the domain name (optional) CTS.DOMAIN= # Please specify the user that receives notifications from CTS CTS.DOCBASE_USER=<DOCBASE_USERNAME> # Please set value to "true" if adding additional domain users, otherwise set it to "false" CTS.ADDITIONAL_DOMAINS=false # Please set value to "true" if selecting this repository as Logging Performance repository, otherwise set it to "false" CTS.IS_PERFORMANCE_LOG_REPO=false # Please specify the products which you want to configed if you install multiple products in same machine. If you config multiple products, use comma as delimiter. # Config will add all products, if this one remain empty.the value can be CTS-Media, CTS-Documents, CTS-Audio-Video, XTS or combination any of them. CTS.MODULE_NAMES= # Please specify the system administrator name and password CTS.SYS_ADMIN_NAME=<CTSHOST_ADMIN_NAME> CTS.SYS_ADMIN_PASS=<CTSHOST_ADMIN_PASSWORD> # Please specify the global repository information DFC.GLOBAL_REGISTRIES=<GLOBAL_REGISTRY_NAME> DFC.GR_USERNAME=<GLOBAL_REGISTRY_USERNAME> DFC.DOCBROKER_HOST=<DOCBROKER_HOST_NAME> DFC.DOCBROKER_PORT=<DOCBROKER_PORT> DFC.SECURE.GR_PASSWORD=<GLOBAL_REGISTRY_PASSWORD> #Below 2 options are used to generate a report of profile customizations applied in the previous installation of CTS. #Use this report to assess the profile customizations you want to apply to the current installation. #Only supported for previously installed CTS versions 7.0, 7.1 or 7.2 #The report by default is available in this location <%CTS HOME%>/migration/log/index.html #Please input the product version you have previously installed. If not 7.0,7.1 or 7.2, please leave it blank CTS.OLD_VERSION= #Please input the previously installed product name, ADTS, AVTS or MTS. #If you have never installed CTS product, please leave it blank. If you have more than one product installed, please separate product name by comma. CTS.OLD_PRODUCTS= # Please specify SSL certificate information. Set "USE_CERTIFICATES" to "true" if you want to enable SSL non-anonymous communication USE_CERTIFICATES=false DFC_SSL_TRUSTSTORE=<ABSOLUTE_PATH_OF_DFC_KEYSTORE> DFC_SSL_TRUSTSTORE_PASSWORD=<TRUSTSTORE_PASSWORD> DFC_SSL_USE_EXISTING_TRUSTSTORE=false # Please specify the information for BOC support CTS.BOCS_SELECTED=<dm_network_location_map object_name> EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 23

24 Installing Content Transformation Services products CTS.ALLOW_BOCS_TRANSFER=<true false> CTS.PREFER_ACS_TRANSFER=<true false> CTS.ALLOW_SURROGATE_TRANSFER=<true false> CTS.DOMAIN_USER_LIST= # Please set value to "YES" if you want CTS to process contents in the distributed store component that is local to the Content Server nearest, otherwise set it to "NO".CTS.PROCESS_LOCAL_CONTENT_ONLY= ##don t change below values INSTALLER_UI=silent 11. Run the installer silently from the command prompt, using this command: ctsconfigurator.exe -f cts_win_config_adding.properties 12. Verify the configuration logs created in the %CTS_HOME%\logs\configurator.log folder. Post-installation tasks After installing Content Transformation Services, perform the following configurations, if required: Enabling a Document Foundation Classes installation to access a global registry, page 24 describes the process to configure the Document Foundation Classes installation to access a global registry, if you did not select a global registry during the installation, or if the password for the global registry user has changed, or if you are updating the dfc.properties file with a different global registry than initially configured. Configuring Content Transformation Server for another repository, page 25 describes the process to add more than one Content Transformation Server configurations to your system. Enhancing memory availability for Content Transformation Services, page 25 describes the process to increase the memory availability of Content Transformation Services. Enabling a Document Foundation Classes installation to access a global registry The dfc.properties file contains properties that relate to accessing the global registry. To enable a Document Foundation Classes installation to access a global registry repository: 1. On the Document Foundation Classes host, navigate to DOCUMENTUM/config. 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, enter the encrypted form of this password in the dfc.properties file. Note: Before executing this command, ensure that the classpath contains dfc.jar or execute the command from a location where dfc.jar is present (for example, C:\Documentum\Shared). 24 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

25 Installing Content Transformation Services products 3. Open the dfc.properties file in a text editor. 4. Modify the following attributes: dfc.bof.registry.repository=<global_registry_repository_name> dfc.bof.registry.username=<user_login_name> dfc.bof.registry.password=<encryped_password_of_user> where encryped_password_of_user is the encrypted password you generated in step 2 above. 5. Save the dfc.properties file. Configuring Content Transformation Server for another repository Run one installation of Content Transformation Services on a single host, and configure it against multiple repositories. The procedure for adding an instance of Content Transformation Services is exactly the same as the procedure for the initial configuration of the product for a repository. This procedure does not perform the base installation or install configuration files, which must be done only once. You do not need to rerun the entire installation procedure to apply Content Transformation Services to an additional repository. See Configuring an instance of a Content Transformation Services server, page 20 for the procedure to configure your product for another repository. Enhancing memory availability for Content Transformation Services The Content Transformation Services memory can be scaled up to increase performance or to allow processing of large files (> 1 GB). The default memory required for Content Transformation Services is 4 GB, but the memory must be increased for the transformation of large files. For every 1 GB RAM added to a minimum 6 GB system RAM, the Content Transformation Services memory can be increased as follows: 1. Log in to the Content Transformation Server host as an administrator user. 2. Select Windows > Administrative Tools > Services to access the Windows Services Utility. 3. Stop Content Transformation Services. 4. Open the Windows registry: Windows->Run->regedit. 5. Navigate to [HKEY_LOCAL_ MACHINE\SYSTEM\CurrentControlSet\services\DocumentumCTS\Parameters]. Modify the value of AppParameters. 6. Increase the -Xmx4096m value by adding 1024 to 4096 for every 1 GB extra RAM added. For example, for 2 GB extra RAM added, add 2048 to Hence, the new value is -Xmx6144m. 7. Close the registry. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 25

26 Installing Content Transformation Services products 8. Restart Content Transformation Services through the Windows Services Utility. 26 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

27 Verifying Content Transformation Services Installation Chapter 2 This chapter explains how to verify an installation of Content Transformation Services. Verifying Content Transformation Services installation This section describes two methods to verify that you have successfully installed Content Transformation Services: Verify if the following Windows services have been started using services.msc: Documentum Content Transformation Services Documentum Content Transformation Monitor Services Documentum CTS Admin Agent Import a test file to the repository. Both tests are recommended. This will ensure your installation is working correctly. Verifying startup of Content Transformation Services service Once Content Transformation Server is installed and configured for a repository, Content Transformation Services should start automatically. To verify startup of Content Transformation Services: 1. Log in to the Content Transformation Server host as an administrator user. 2. Select Windows > Administrative Tools > Services to access the Windows Services utility. 3. Start Documentum Content Transformation Services. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 27

28 Verifying Content Transformation Services Installation 4. Navigate to the %CTS_HOME%\logs folder and open the CTS_log.txt file. Ensure that there are no errors or exceptions in the log file. At the end of the log file, a message that reads "Product <CTS product> version <version number> is installed on repository: <repository name> must appear. 28 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide

29 Unconfiguring and Uninstalling Content Transformation Services Chapter 3 To install Content Transformation Services, uninstall previous versions of Content Transformation Services components. You must unconfigure Content Transformation Services before uninstalling it. If you are installing Content Transformation Services the first time, skip to Chapter 1, Installing Content Transformation Services products. Unconfiguring Content Transformation Services This section provides information to unconfigure Content Transformation Services manually or in silent mode. Unconfiguring a Content Transformation Services instance manually This section describes how to manually remove an instance of Content Transformation Services from a repository. This procedure does not remove the configuration files and services associated with the Content Transformation Server. Uninstalling Content Transformation Services products, page 31 describes the process to remove Content Transformation Server from a host. To manually unconfigure a Content Transformation Services instance 1. Navigate to Content Transformation Services Configurator under Start > Programs > CTS Configuration Utility. 2. Click Next. 3. Accept the terms of the license agreement, and click Next. 4. Select Remove a Content Transformation Services instance from a repository and click Next. 5. Select the repository from which you want to remove the Content Transformation Server. Enter the SuperUser name, the SuperUser password, and the Domain if any. 6. Click Next. The CTS Configuration Program screen appears. EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide 29

30 Unconfiguring and Uninstalling Content Transformation Services 7. Select the Content Transformation Services products (CTS Documents, CTS Audio-Video, CTS Media, XTS) that must be removed from the repository. Note: This screen does not appear if only one Content Transformation Services product is configured to the repository. 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. Click Done in the dialog box indicating the success of the Content Transformation Server removal. This instance of Content Transformation Server is now removed from the repository. Unconfiguring Content Transformation Services instance in the silent mode The silent unconfigurator allows you to provide installation, repository, and global registry information in a configuration file, after which you can run the configurator batch files. 1. Login to the selected Content Transformation Server host as an Administrator user. 2. Ensure that no programs or applications are running on the host. 3. Update the cts_win_config_removing.properties file with relevant values using a text editor:: # Please specify the config actions, "add" or "remove". CTS.INSTALL_TYPE=remove # Please specify the host name for CTS machine CTS.HOSTNAME=<CTS_HOST_NAME> # Please specify the repository name CTS.DOCBASE=<DOCBASE_FROM_WHICH_CTS_TOBE_UNCONFIGURED> # Please specify the repository super user and password CTS.DOCBASE_SUPERUSER=<DOCBASE_SUPER_USER> CTS.NOT_ENCRYPTED_PASSWORD=<DOCBASE_PASSWORD> # Please specify the domain name (optional) CTS.DOMAIN= # Please specify the products which you want to remove if you install multiple products in same machine. If you remove multiple products, use comma as delimiter. # Config will remove all products, if this one remain empty. The value can be CTS-Media, CTS-Documents, CTS-Audio-Video, XTS or combination any of them. CTS.MODULE_NAMES= ##don t change below values INSTALLER_UI=silent 4. Open the command prompt and navigate to the to %CTS_HOME%\server_install directory where the cts_win_config_removing.properties file present. Run the installer silently from that command prompt using the following command: ctsconfigurator.exe -f cts_win_config_removing.properties 30 EMC Documentum Content Transformation Services Transformation Suite Version 7.3 Installation Guide