EMC Documentum Import Manager Version 6 Installation and Con guration Guide 300 005 288 EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com
Copyright 2007 EMC Corporation. All rights reserved. Published August 2007 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... 5 Chapter 1 Import Manager Overview... 7 What is Import Manager?... 7 Chapter 2 Installing Import Manager on Windows... 9 Pre-installation Requirements for Windows... 9 Software Requirements... 9 Installing Import Manager on Windows... 10 Installing the Import Manager DocApp... 13 Installing the Import Manager DocApp on a repository... 13 Verifying Installation on Windows... 15 Uninstalling Import Manager on Windows... 15 Chapter 3 Con guring Import Manager... 17 Configuring the Workflow Target Folder... 17 Changing the Font Used in Import Manager... 18 Assigning Repository Formats to File Extensions... 18 Configuring the Repositories Available to Import Manager... 19 Configuring Import Manager Logging... 20 EMC Documentum Import Manager Version 6 Installation and Con guration Guide 3
Table of Contents List of Tables 4 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Preface This manual contains information and instructions needed to install and configure the Import Manager utility and describes how it works and interacts with a Documentum repository. In addition, this manual outlines requirements that must be met before installation, and provides step-by-step instructions for installing, uninstalling, and configuring Import Manager. For support and to ensure that you install the current version of this product and that you have the correct documentation, including the latest version of this document, visit the http://powerlink.emc.com and review the product versions available for your platform. Intended Audience This manual is primarily intended for the person responsible for installing and uninstalling Import Manager. Readers should be familiar with Windows Operating Systems. Conventions This guide uses the following conventions: Conventions Convention italics typewriter code Description Represents a pop-up or pull-down menu. For example, File Save As means choose File on the toolbar and then choose Save As from the pull-down menu. Represents a variable name for which you must provide a value, or a defined term. Represents user input. Represents sample code. [] square brackets Indicates an optional argument. EMC Documentum Import Manager Version 6 Installation and Con guration Guide 5
Preface Convention Description {} curly brackets Indicates an optional argument that can be repeated more than once. /foldername_or_filename Represents the name of a file or file path. Note: The forward slash (/) in this notation has exactly the same meaning as a backslash (\) in the names of Windows files and paths. Revision History The following changes have been made to this document. Revision History Revision Date August, 2007 Description Initial Release. 6 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Chapter 1 Import Manager Overview This chapter provides an overview of Import Manager. It includes the following sections: What is Import Manager?, page 7 What is Import Manager? Import Manager is a stand-alone java application for organizations that want to import massive amounts into a Documentum repository. Documentum Import Manager provides an easy-to-use interface that allows large amounts of content and metadata information to be imported into a Documentum repository conveniently and efficiently. With Import Manager thousands of files of any file format or size can be loaded into Documentum repositories with some simple instructions. For example, new Documentum customers can import all of their existing (legacy) files into a new Documentum repository easily and quickly. As well, it allows customers to import large batches of objects whenever they choose. Import Manager allows users to specify object type, attributes, permissions, and folder paths. The repository object is created from the information that is submitted using the Import Tool. When used in conjunction with Documentum Media Transformation Services, imports of any media file format imported via Import Manager may take advantage of its analysis and transformation functions. EMC Documentum Import Manager Version 6 Installation and Con guration Guide 7
Import Manager Overview 8 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Chapter 2 Installing Import Manager on Windows This chapter explains how to install Import Manager on a Windows host. It describes pre-installation requirements and contains instructions for installing Import Manager. This chapter also describes how to verify the installation and explains how to uninstall Import Manager. It contains the following sections: Pre-installation Requirements for Windows, page 9 Installing Import Manager on Windows, page 10 Installing the Import Manager DocApp, page 13 Verifying Installation on Windows, page 15 Uninstalling Import Manager on Windows, page 15 Pre-installation Requirements for Windows This section describes the prerequisites for a successful Import Manager installation on a Windows client and contains software requirements. It is important that you review these sections prior to installation. Before you begin the installation process, you should also verify that you have access to the Documentum Download Center (http:\\powerlink.emc.com) so you can retrieve the installation files. Software Requirements The following software is required to run Import Manager on a Windows host. This list illustrates the order in which the software should be installed. All of the following supporting software should be installed prior to installing Windows operating system (Windows 2003 or Windows XP) Winzip (to decompress file if IM has been zipped) Microsoft Office (to identify documents) EMC Documentum Import Manager Version 6 Installation and Con guration Guide 9
Installing Import Manager on Windows Adobe Acrobat Reader (to launch IM help) You must install the correct version of each software product that runs with Import Manager before you begin the installation. See the Import Manager Release Notes for the software versions certified to run with your version of Import Manager. After installing Import Manager, a DocApp must also be run against any repository where you intend to import files using Import Manager. This requires that Documentum Application Installer (DAI) must be available on a Windows machine that is accessible to the repository(s). A user ID with SuperUser access on the repository(s) must also be available. For more detailed information about installing a DocApp, see the Documentum Application Installer Installation and Release Notes. Installing Import Manager on Windows This section describes how to install Import Manager on a Windows host. Before you install, make sure the machine on which you are installing Import Manager meets all of the requirements outlined in Software Requirements, page 9. To install Import Manager on Windows: 1. Download the Import Manager Installer zip file from the Documentum download center to a temporary directory on your host. If you cannot locate your password for the download site, use the password finder on the bottom of the download page. Use your email address as your user name. 2. Extract the installer zip file to the temporary directory. 3. In the extracted installer folder, navigate to and double-click the file ImportManagerSuiteSetup.exe. 4. The Import Manager Installation Wizard splash screen is displayed, followed by the Welcome screen. Click Next. 5. The license agreement terms are displayed. Select the radio button to agree with the licensing terms, then click Next. 6. The DFC Runtime Environment Optional Features screen appears. To install the DFC developer documentation, select the Developer Documentation checkbox. To install the Primary Interop Assembly Installer, select the checkbox. The Primary Interop Assembly Installer installs a Microsoft installer package (.msi file) for the DFC primary interop assembly (PIA). Leave the box unchecked if you do not wish to have the package installed. The installer places the installer package for the DFC PIA into the setup subdirectory of the program root. 10 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Installing Import Manager on Windows 7. Click Next. At this point, if the DFC is already present, you can proceed to Step 10. If a version of the DFC newer than the version included with the Import Manager installer is installed, you are given a warning that the version is not supported by this version of Import Manager. It is recommended that you uninstall this version of the DFC, or contact your Documentum technical support representative to find out if a newer version of the Import Manager that is compatible with this newer version of the DFC is available. 8. Install DFC if it is not already on the host by performing the following substeps. a. Accept the default DFC program root or enter a different directory and click Next. The default is C:\Program Files\Documentum\ImportManager. b. Accept the default user directory or enter a different directory and click Next. The default is C:\Program Files\Documentum\ImportManager. Note: If the DFC has been previously installed on your system, the DFC will be reinstalled in the previous installation location and you will not see these screens. Proceed to Step 10. 9. If you are prompted, enter a connection broker host name and port number or accept the default and click Next. Note: If you already have a dfc.properties file on your system, you will not see this screen. Proceed to Step 10. 10. Identify the Import Manager installation directory. It is recommended that you accept the default directory, where your other Documentum products are installed. For example, if your other Documentum products are installed in the C:\Program Files\Documentum\ImportManager directory, you should install Import Manager in C:\Program Files\Documentum\ImportManager. To accept the default directory (C:\Program Files\Documentum\ImportManager), click Next. To choose another directory, click Browse, navigate to the directory, and click Next. 11. The Pre-Installation Summary screen appears. Review the installation specifications. When you are satisfied that they are correct, click Next. 12. The installation process begins. 13. After the installation has finished, you are prompted to Set BOF Global Registry Properties. Specify the global registry if you wish to deploy business objects from a single central source. You can safely leave the Set BOF Global Registry Properties checkbox EMC Documentum Import Manager Version 6 Installation and Con guration Guide 11
Installing Import Manager on Windows unchecked. You can establish a global registry later if you wish to do so. The global registry is part of the DFC 6.0 deployment mechanism for business objects. It allows you to deploy business objects automatically from a central Documentum repository. If you have deployed business objects using the original deployment mechanism, you can continue to do so. You can also use the new and old mechanisms together and migrate gradually to the new mechanism. For information about deploying business objects, refer to DFC Development Guide. This manual is available with a Developer Studio license. To specify the global registry: a. Select the Set BOF Global Registry Properties checkbox. b. Enter the desired values into the following fields: Repository The repository that will host the global registry. This repository must be available from the connection broker you have specified for this DFC installation. User Name The user name that will connect to the repository and access the global registry. This user should already have been created specifically for this purpose. Group Name The group that needs to be created as part of the server installer. User Password The password for the specified user. Domain The domain for the specified user. Leave this field blank unless your installation requires it to log in to a repository. By default, the installer validates the above entries against the specified repository. To avoid this validation, uncheck the Validate Field Values checkbox. c. Click Next. By default, the installer validates the above entries against the specified repository. To avoid this validation, uncheck the Validate Field Values checkbox. Note that the installer will fail if you check this box, unless you have manually changed permissions for the BOF user that is set up in the global registry repository. See the Content Server release notes for details on how to manually change permissions. Notes: This window does not appear until after the installer has successfully installed all product components. This window does not appear if the installer finds values for dfc.bof.registry. repository, dfc.bof.registry.username, and dfc.bof.registry.password in the dfc.properties file. The User Password is encrypted before it is saved to the dfc.properties file. 14. You are notified that installation was successful. Click Next. 12 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Installing Import Manager on Windows 15. When the installation has finished, you are prompted to restart the machine either now or later. a. If you choose to restart later, make the appropriate selection and click Next. The installation wizard closes. b. If you choose to restart now, make the appropriate selection and click Next. The installation wizard closes and the host restarts. If you select Cancel at the restart system prompt or do not receive the restart system prompt, this will close the installation wizard and the installation will be incomplete. To complete the installation and start using Import Manager, you must restart the machine either through the installer or manually. Installing the Import Manager DocApp After you install Import Manager and before you use Import Manager, you must install a DocApp on each repository you plan to access through Import Manager. An Import Manager DocApp (Import_Manager_6.0.0.016_docapp.zip) is provided on the Documentum Download Center (https://powerlink.emc.com). Note: You must run the Documentum Application Installer (DAI) on any Windows machine that is accessible to the repository that you want to configure with Import Manager. The user that you use to log into the repository must have SuperUser access. The repository where you are installing the DocApp must be running when the DocApp is installed. For more detailed information about installing a DocApp, see the Documentum Application Installer Installation and Release Notes. Installing the Import Manager DocApp on a repository Use these instructions to install the default Import Manager DocApp on a Documentum repository. The DocApp must be installed from a Windows computer that has Documentum Application Builder or Application Installer (former DocApp Installer) installed. Documentum Application Installer creates a DocApp log file called ImportManager_installerLog.html when you install the Import Manager DocApp. The log file is saved to the Desktop folder on the Application Installer machine. By default, the file name is "ImportManager_installerLog.html". EMC Documentum Import Manager Version 6 Installation and Con guration Guide 13
Installing Import Manager on Windows To install the Import Manager DocApp on a repository: 1. Log in to a Windows host where the Documentum Application Installer (DAI) is installed. 2. Download the Import Manager DocApp from the Documentum Download Center (https://powerlink.emc.com) or transfer it to the Windows host where DAI is installed. 3. Unzip the Import Manager DocApp to a temporary folder. The zip file will extract to a folder called ImportManager. Caution: Do not rename the ImportManager folder. 4. Ensure that the dfc.properties file on the host is pointing to a connection broker to which the repository projects. For example, if the repository projects to a connection broker called Troy, ensure that Troy is listed in the dfc.properties file. The dfc.properties file is in the C:\documentum\config folder. 5. On the Windows host, click Start Programs Documentum Application Installer. The Documentum Login dialog box is displayed. 6. In the Repository field, select the repository where you are installing the Import Manager DocApp. 7. Enter the user name and password of a user who has SuperUser privileges in the repository. 8. Click OK. The Select DocApp Archive dialog box is displayed. 9. Browse to the ImportManager folder in the unzipped folder from Step 3. 10. Click OK. 11. If required, specify a different Application Installer log file name and location. The default location for the log file is the Desktop folder on the Application Installer machine. 12. Click OK. The DocApp Installer dialog box is displayed. 13. Verify that the information on the dialog box is correct. 14. Click Start Installation. A prompt is displayed. 15. Click OK. 14 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Installing Import Manager on Windows 16. If the Connected Users dialog box is displayed, click Yes. If the DocApp Installer dialog box displays the following, the installation succeeded: <P>COMMIT TRANSACTION</P>. xxxx INSTALLATION DONE xxxx. If the DocApp Installer dialog box displays the following, the installation failed: <P>ABORT TRANSACTION</P>. When the installation is complete, you may also open the log file to verify a successful installation. 17. Click Quit Installer. 18. Repeat this procedure for each repository where you intend to use Import Manager. Verifying Installation on Windows Once the Import Manager installation has completed, an Import Manager icon is added to your desktop and to Programs in the Windows Start menu. Verifying installation of Import Manager: 1. Navigate to Start Programs Documentum Import Manager or double click the Import Manager icon on your desktop. 2. Import Manager starts and the Import Monitor window appears. Uninstalling Import Manager on Windows This section describes how to uninstall Import Manager from a Windows host. There are two methods for uninstalling Import Manager. It is preferable to use the Windows Add/Remove feature to uninstall Import Manager. Using Windows Add/Remove Programs to Uninstall Import Manager: 1. Stop the Import Manager application if it is currently running. 2. Click Start Settings Control Panel and double-click Add or Remove Programs. 3. In the Change or Remove Programs window, locate the Documentum Import Manager program, select it, and click Change/Remove. 4. The Import Manager uninstall wizard opens. Click Next. EMC Documentum Import Manager Version 6 Installation and Con guration Guide 15
Installing Import Manager on Windows 5. The uninstall notification appears, indicating the location from which Import Manager will be uninstalled. Click Next. 6. The uninstall proceeds. For any files that have been modified since installation, select Yes or No to uninstall them. 7. When it is finished, you receive an Uninstall Complete notification. Click Finish to close the uninstaller. Using the Uninstall wizard to Uninstall Import Manager: 1. Stop the Import Manager application if it is currently running. 2. On the client, navigate to the directory _uninst in the root location of the install (e.g. C:\Program Files\Documentum\_uninst). 3. Open the importmanager folder. 4. Double-click the file uninstaller.exe. 5. The Import Manager uninstall wizard opens. Click Next. 6. The uninstall notification appears, indicating the location from which Import Manager will be uninstalled. Click Next. 7. The uninstall proceeds. For any files that have been modified since installation, select Yes or No to uninstall them. 8. When it is finished, you receive an Uninstall Complete notification. Click Finish to close the uninstaller. 16 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Chapter 3 Con guring Import Manager The tasks in this chapter allow you to configure your installation of Import Manager. The following tasks are included: Configuring the Workflow Target Folder, page 17 Changing the Font Used in Import Manager, page 18 Assigning Repository Formats to File Extensions, page 18 Configuring the Repositories Available to Import Manager, page 19 Configuring Import Manager Logging, page 20 Con guring the Work ow Target Folder Users can apply any installed workflow to import jobs as a post-process. Each imported file can be added as a package to a new workflow instance, or all the files in an import job can be added as a whole to one new workflow instance. In the latter case, a new folder with a configurable name is created in the target folder and all the imported files in the job are linked to this folder. The folder name is constructed using a user-defined prefix in the ImportManager_Configuration.properties file. This folder is added as a package to a new instance of the chosen workflow template. Note: Workflows that do not allow folders to be added as packages will cause an error. If the workflow chosen has a dynamic performer in the start activity, the user can specify this performer. The case where an alias set is defined for the workflow definition, and that alias set contains aliases but no names mapped to them, is not supported. For more information on workflows, see the Workflow Manager documentation, such as the Workflow Manager User Guide. To set the work ow target folder: 1. Navigate to the ImportManager_Configuration.properties file located in the Import Manager installation folder (e.g. C:\Program Files\Documentum\ImportManager). EMC Documentum Import Manager Version 6 Installation and Con guration Guide 17
Con guring Import Manager 2. Open the file in any text editor. 3. Locate the line workflow_folder_prefix=workflow_folder_ 4. Replace workflow_folder_ with the folder prefix you would like all of your workflow folders to have. Note: The suffix of the constructed folder name is the job ID. This will create a folder called <workflow>nn (where <workflow> is the prefix folder name you have specified above and nn is the import job number) when you apply a workflow per job. 5. Save and close the configuration file. Changing the Font Used in Import Manager Import Manager, by default, uses a font that cannot display double-byte characters (i.e. Trebuchet MS ). To view double-byte characters (i.e. Korean or Japanese) in Import Manager, it is necessary to change the font used in Import Manager. By changing the font used to Batang, you can then see Japanese and Korean characters in file/folder names when selecting them for import. As well, you can then enter double-byte characters in the attributes section for files/folders or for the job title. To change the font used in Import Manager: 1. Navigate to the ImportManager_Configuration.properties file located in the Import Manager installation folder (e.g. C:\Program Files\Documentum\ImportManager). 2. Open the file in any text editor. 3. Locate the line font=trebuchet MS 4. Replace Trebuchet MS with Batang or another font that you wish to use. 5. Save and close the configuration file. Assigning Repository Formats to File Extensions Given a file extension, Import Manager assigns a repository format based on settings in the repository. In the case where multiple formats apply to a file extension, the first available one will apply. If you wish to override this mapping, a configuration 18 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Con guring Import Manager file, dctmformats.txt, is available in the Import Manager installation directory for this purpose. The contents of the file are of the format: extension, documentum format, You can edit this file to add other formats supported within the repository (e.g. jpeg) or change what is already defined. To assign repository formats to le extensions: 1. Navigate to the dctmformats.txt file located in the Import Manager installation folder (e.g. C:\Program Files\Documentum\ImportManager). 2. Open the file in any text editor. 3. Enter a new file extension and associated Documentum format or change existing extension and format associations. You must include a comma following the Documentum format. You also must enter a carriage return after the last entry. 4. Save and close the configuration file. Con guring the Repositories Available to Import Manager If you already have a Documentum product on your system, it will already be configured with an appropriate connection broker, that will allow you to access repositories. If you are installing Import Manager for the first time and there have been no other Documentum products installed on the system, the Import Manager installer prompts you to enter the primary connection broker. The dfc.properties is created automatically and contains the primary connection broker information. The dfc.properties file is used by all Documentum products installed on your system. You may want to be able to access repositories across multiple connection brokers. To do this you can add backup connection brokers. Contact your administrator for the connection broker names and repositories available to them. Note: All repositories specified in your dfc.properties file s Primary connection broker and Backup connection broker sections appear under repositories. For more information on the parameters that can be set in the dfc.properties, please refer to Content Server Administrator s Guide. EMC Documentum Import Manager Version 6 Installation and Con guration Guide 19
Con guring Import Manager To modify the dfc.properties le for available repositories: 1. Navigate to and open the dfc.properties file (located in C:\documentum\config) using any text editor. 2. Change the dfc.docbroker.host[0]=<docbroker name> entry to be the name of the connection broker you want to access as the primary connection broker. For example, for a connection broker named MyDocbroker1, enter the following: dfc.docbroker.host[0]= MyDocbroker1 3. To add an additional connection broker, you can add additional dfc.docbroker.host[n] entries with the connection brokers you want to contact to get a list of repositories. For example, for a connection broker named MyDocbroker2, enter the following: dfc.docbroker.host[0]= MyDocbroker1 dfc.docbroker.host[1]= MyDocbroker2 Con guring Import Manager Logging When the DFC is installed, it creates a log4j.properties file in the Documentum config directory (usually C:\Documentum\config\). The Import Manager installer appends the following lines to this file: log4j.rootcategory=warn, A1, F1 log4j.category.mute=off log4j.additivity.tracing=false log4j.category.tracing=debug, FILE_TRACE #------------------- CONSOLE -------------------------- log4j.appender.a1=org.apache.log4j.consoleappender log4j.appender.a1.threshold=error log4j.appender.a1.layout=org.apache.log4j.patternlayout log4j.appender.a1.layout.conversionpattern=%d{absolute} %5p [%t] %c - %m%n #------------------- FILE -------------------------- log4j.appender.f1=org.apache.log4j.rollingfileappender log4j.appender.f1.file=c\:/documentum/logs/log4j.log log4j.appender.f1.maxfilesize=10mb log4j.appender.f1.layout=org.apache.log4j.patternlayout log4j.appender.f1.layout.conversionpattern=%d{absolute} %5p [%t] %c - %m%n #------------------- FILE_TRACE -------------------------- log4j.appender.file_trace=org.apache.log4j.rollingfileappender log4j.appender.file_trace.file=c\:/documentum/logs/trace.log log4j.appender.file_trace.maxfilesize=100mb log4j.appender.file_trace.layout=org.apache.log4j.patternlayout log4j.appender.file_trace.layout.conversionpattern=%d{absolute} [%t] %m%n 20 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Con guring Import Manager You can change the logging level by replacing "ERROR" in the first line with: DEBUG, INFO, WARN, ERROR and FATAL. The logging level of detail also follows the order in which they are listed. You can also configure several other options, including the location of the log file by editing the line indicated above with the new location. More details about log4j can be found at http://logging.apache.org/log4j/docs/ documentation.html. EMC Documentum Import Manager Version 6 Installation and Con guration Guide 21
Con guring Import Manager 22 EMC Documentum Import Manager Version 6 Installation and Con guration Guide
Index C configuring available repositories, 19 workflow target folder, 17 conventions, 5 D DocApp, installing, 13 DocApp, log file, 13 F font changing, 18 I Import Manager description of, 7 installing on Windows, 10 uninstalling on Windows, 15 verifying installation, 15 Import Manager DocApp, installing, 13 Import Manager DocApp, log file, 13 installing Import Manager verifying install, 15 Import Manager DocApp, 13 installing Import Manager pre-installation requirements for Windows, 9 software requirements, 9 Windows, 10 J Japanese supporting, 18 K Korean supporting, 18 L languages double-byte characters, 18 log file, DocApp installer, 13 P pre-installation requirements Windows, 9 Windows, software, 9 R repositories making available to Import Man ager, 19 S software requirements Windows, 9 U uninstalling Import Manager Windows, 15 V verifying installation, 15 W workflow target folder configuring, 17 EMC Documentum Import Manager Version 6 Installation and Con guration Guide 23