EMC Documentum ContentServicesforSAP Version6.5 ... SAP-relatedissues,suchasemptyorwronglyconfiguredtables ... DMS-relatedOSSNotesandpatchespriortoCSSAPinstallation

EMC® Documentum®

Content Services for SAPVersion 6.5

Installation Guide

P/N 300-006-304 Rev A04

EMC CorporationCorporate Headquarters:

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

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

The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kindwith respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitnessfor a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires anapplicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarksused herein are the property of their respective owners.© Copyright 2010 EMC Corporation. All rights reserved.

Table of Contents

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

Chapter 1 Preparing to Install Content Services for SAP ............................................. 11General prerequisites ........................................................................................ 11Software prerequisites ...................................................................................... 11Installation scenarios ........................................................................................ 11Installing required EMC Documentum software ................................................. 12Installing EMC Documentum Administrator .................................................. 12

SAP R/3 or ECC server (UNIX or Windows) ....................................................... 12Preinstallation checklist .................................................................................... 13

Chapter 2 Installing CS SAP Server Components ........................................................ 15Obtaining current version software from the Documentum DownloadCenter.............................................................................................................. 15Installing Enterprise Integration Core DAR file................................................... 16Installing CS SAP WebAdmin in Documentum Administrator............................. 17Installing the High Volume Processing Server (HVPS)......................................... 18Installing the hvps.dar file............................................................................. 19Deploying the HvpWorker.war file ................................................................ 20Deploying HvpWorker.war on Apache Tomcat........................................... 21Deploying HvpWorker.war on BEAWebLogic ........................................... 21Deploying HvpWorker.war on IBMWebSphere.......................................... 23ClassLoader setting .............................................................................. 23

Deploying HVPWorker.war on JBoss ......................................................... 24Significant system objects .......................................................................... 24dfc.properties ....................................................................................... 24log4j.properties .................................................................................... 25HVP.properties .................................................................................... 25

Postinstallation conguration .............................................................................. 25Setting Windows environment variables ........................................................ 25Setting UNIX environment variables.............................................................. 26

Customization using dmei_custom_installer utility............................................. 28

Chapter 3 Installing CS SAP client components .......................................................... 31Obtaining current version software from the Documentum DownloadCenter.............................................................................................................. 31System configuration and dependencies............................................................. 31User roles and client components ...................................................................... 32Installation prerequisites ................................................................................... 32Customizing installation ................................................................................... 33Installing CS SAP Client Components ................................................................ 35Configuring WebView .................................................................................. 36

EMC Documentum Content Services for SAP Version 6.5 Installation Guide 3

Table of Contents

Installing Daeja ViewerOne Pro version 1.1.80 ............................................ 36Installing the image services .dar file...................................................... 37

Configuring the View component for Webtop or WebView.............................. 37Configuring Brazilian Portuguese Language Pack for WebView....................... 38Configuring Korean Language Pack for WebView .......................................... 38Silent installation .......................................................................................... 39

Postinstallation tasks........................................................................................ 40Disabling tag pooling for WebView ............................................................... 40

Chapter 4 Upgrading CS SAP ...................................................................................... 41Upgrading the CS SAP server............................................................................ 41Upgrading from CS SAP 5.3 SPx server .......................................................... 41Upgrading from CS SAP 6.0, 6.0 SP1 server .................................................... 42Upgrading from CS SAP 6.5, 6.5 SPx server .................................................... 43

Upgrading CS SAP client components ............................................................... 43

Chapter 5 Testing the Installation ................................................................................ 45Logging in to WebAdmin through Documentum Administrator.......................... 45Configuring the SAP server ............................................................................... 46Configuring an SAP user................................................................................... 47Creating an SAP query...................................................................................... 47Testing an SAP query........................................................................................ 49Configuring an Agent ....................................................................................... 49Registering an HVP worker............................................................................... 50Configuring CS SAP job .................................................................................... 50

Chapter 6 Uninstalling CS SAP .................................................................................... 53Uninstalling CS SAP server components ............................................................ 53Deleting default SAP configuration information or data .................................. 53

Uninstalling CS SAP client components ............................................................. 54

Appendix A Installing a DAR file using the DAR Installer GUI ........................................ 55

Appendix B Troubleshooting .......................................................................................... 59

4 EMC Documentum Content Services for SAP Version 6.5 Installation Guide

Table of Contents

List of Tables

Table 1. System configuration and dependencies................................................................. 12Table 2. UNIX environment varibles................................................................................... 26Table 3. Installer properties file values................................................................................ 28Table 4. System configuration and dependencies................................................................. 31Table 5. Query types ......................................................................................................... 48Table 6. DAR Installer fields .............................................................................................. 56


Table of Contents


Preface

Purpose of this guideThis manual explains how to install and configure the components of EMC Documentum ContentServices for SAP (CS SAP) 6.5. It contains information about installation requirements, and providesdetails of the tasks performed with the software.

Intended audienceIn order to address the manuals to the correct audience, the roles of the users of the manuals havebeen defined as follows:

• System Administrator — This role covers users who install and configure CS SAP. The CS SAPapplication integrates EMC Documentum and the SAP R/3 or ECC system. Therefore, systemadministrators must have experience with the software products listed in the EMC DocumentumContent Services for SAP Release Notes.

• Content Services Administrator — This role covers users who manage CS SAP using WebAdmin.

• Document Controller — This role covers those who release documents to SAP and maintain thelinks to those documents.

• Standard User — This role covers users who view documents using the SAP GUI and the Viewcomponent of CS SAP.

This manual is intended for System Administrators.

Revision historyThis section contains a description of this document’s revision history.

Revision history

Revision date Description

July 2008 Initial publication of document for CS SAP 6.5.

September 2008 Addition of DAR utility installation information.

June 2009 Update publication of document for CS SAP 6.5Rev A03.

March 2010 Addition of CSSAP upgradation informationRev A04


Preface

Typographic conventionsThis guide uses the following text conventions.

Typographic conventions used in this guide

Convention Description

> Represents a pop-up or pull-down menu.

<Text enclosed within angle brackets> Represents a variable name for which you mustprovide a value, or a defined term.

Information in this fontRepresents code samples, user input, andcomputer output.

[] square brackets Used in method command syntax specifications,square brackets indicate an optional argument.

{} curly brackets Used in method command syntax specifications,curly brackets indicate an optional argumentthat can be repeated more than once.

Related documentationThis manual forms part of a documentation suite designed to support those who install, configure,and use CS SAP. The product and documentation suite can be found on EMC Powerlink, located at:http://Powerlink.EMC.com.

From Powerlink, you can download the latest version of CS SAP and the related documentationsuite. To access the contents in Powerlink, you will need to provide the login credentials assigned toyou when you first applied for access.

Note: Your login ID, by default, is your email address. If you cannot locate your password, use thepassword finder at the bottom of the login page.

If you are accessing Powerlink for the first time, you will need to apply for access and obtain ausername and password.

Content Services for SAP — Documentation suite

Title Description Target role

EMC Documentum ContentServices for SAP Release Notes

Provides an overview ofnew and amended features,known bugs, limitations,miscellaneous technical notes,and documentation correctnessand clarifications.

Standard User, SystemAdministrator, SystemAdministrator (SAP), andContent Services Administrator

EMC Documentum ContentServices for SAP InstallationGuide

Provides the procedures forinstalling Content Services.

System Administrator


https://documentum.subscribenet.com

Preface

Title Description Target role

EMC Documentum ContentServices for SAP ConfigurationGuide

Describes the configurationtasks that need to be performedin SAP so that SAP cancommunicate with ContentServices.

System Administrator (SAP)

EMC Documentum ContentServices for SAP AdministrationGuide

Describes how to configureContent Services using theWebAdmin tool.

Content Services Administrator

EMC Documentum ContentServices for SAP User Guide

Describes how SAP users viewdocuments.

Standard User


Preface


Chapter 1Preparing to Install Content Servicesfor SAP

This chapter provides information about preparing to install CS SAP.

General prerequisitesThe person installing CS SAP should have administrative experience with the software productslisted in the EMC Documentum Content Services for SAP Release Notes.

Note:• Unless the person installing the product has the prerequisite experience, EMC Documentumrecommends that you do not perform installations by using only EMC Documentum manuals asguidance.

• EMCDocumentum Support can assist only with systemswhich were installed by qualified personsfollowing the specific instructions outlined in both the documentation and the training manual.

Software prerequisitesCS SAP depends on specific versions of EMC Documentum and third-party products, as described inthe ’Software Requirements’ section of the EMC Documentum Content Services for SAP Release Notes.

Installation scenariosCS SAP is an integrated suite of products that provide document management, imaging andarchiving services. Services can be installed on different physical machines in different locationsas long as the required functional components for each specific service are on the same machine.The following table provides an overview of possible system configurations and the functionalcomponent dependencies for each service or function.

Note: SAP GUI is not required when using only server components and agents.


Preparing to Install Content Services for SAP

Table 1. System configuration and dependencies

System configuration Functional component dependencies

CS SAP administration including automatedlinking and data replication.

Content Services for SAP WebAdmin plus HVPWorker

Browser enabled viewing client — Viewdocuments by selecting a link in SAP GUI.

SAP GUI plus View component — Installedwith Webtop integration

OLE viewing client — View documents byselecting a link in SAP GUI or by calling a DRLdirectly from the repository.

SAP GUI plus View component

OLE viewing client — View documents bycalling a DRL directly from the repository.

View component

SAP DMS linking — Links EMC Documentumdocuments to SAP equipment, material,functional location, customer, vendor, WBSelement, or document info record.

View component plus Manage component

Installing required EMC Documentum softwareThis section contains information about EMC Documentum software that must be installed priorto installing CS SAP.

Installing EMC Documentum Administrator

After the database and Documentum Content Server have been installed, install DocumentumAdministrator as described in the EMC Documentum Administrator Deployment Guide.

After the Documentum Administrator installation is complete, install the preferred CS SAPcomponents as described in Installing CS SAP Server Components.

SAP R/3 or ECC server (UNIX or Windows)Manual configuration of SAP ArchiveLink and SAP DMS are prerequisites for installation of CS SAP,as described in the EMC Documentum Content Services for SAP Configuration Guide.

Caution: Documentum is not responsible for problems encountered during installation due toSAP-related issues, such as empty or wrongly configured tables, or needed support packages,hot fixes, or OSS Notes. Documentum requires that you read and apply all ArchiveLink andDMS-related OSS Notes and patches prior to CS SAP installation. Documentum support is notresponsible for answering SAP configuration questions or problems.



Preinstallation checklistYou must follow the information in the preinstallation checklist before you install CS SAP. If thepreinstallation tasks are not done, your system will not function properly:

1. Launch SAP GUI from the intended CS SAP server or client and log in to the SAP system youwant to support. If this test fails, you must resolve the connection between CS SAP and the SAPsystem before proceeding.

2. Be sure all previous versions of DocLink and Content Services are either physically removedor deactivated.

3. The repository should be up, running, and performing before installing CS SAP. CS SAP requiresa fully functioning repository and writes configuration objects into the chosen repository duringthe install. The installation creates an SAP cabinet and writes CS SAP admininstrative objectsunder the system cabinet.

4. Create a directory on the SAP server. This directory will be used by SAP to store files temporarilyuntil they are transported into Documentum.

5. To use CS SAP with HTTP archiving services, install AS SAP, as described in the EMCDocumentum Archive Services for SAP Installation Guide.

6. Create an SAP user ID. Designate the user as a Dialog User. This user ID will be used to connectto SAP to run queries. Give the user account sufficient access to all SAP data that will be queriedduring CS SAP operations.

7. Make sure the application server and Documentum Administrator is up and running. WebAdminis installed after installing Documentum Administrator.

Note: From 6.5 release, the administration console for both AS SAP and CS SAP is the same. InstallingWebAdmin (packaged as dmei_webadmin.zip) component on DA would enable users to administerboth CS SAP and AS SAP. However, the CS SAP would need HVPS component in addition to whatAS SAP requires for executing the DMS related activities.




Chapter 2Installing CS SAP Server Components

This chapter describes the procedure for installing CS SAP.

Note: The components of CS SAP are configured by using WebAdmin, which is installed with theother components. Instructions for using WebAdmin are provided in the EMC Documentum ContentServices for SAP Administration Guide.

Obtaining current version software from theDocumentum Download CenterTo ensure that you install the current version of this product, visit the EMC Download Center athttps://EMC.subscribenet.com and review the product versions available for your platform.

For Windows, download Content_Services_for_SAP_6.5_server_Windows.zip, which contains thefollowing files:

• Enterprise_Integrations_Core.zip — Contains the Enterprise Integrations Core DAR file andrelevant script files for installing the DAR using the command line.

• dmei_webadmin.zip — Contains the WebAdmin administration component that would beinstalled on DA.

• hvps.zip — Contains the HVPS DAR file and relevant script files for installing the DAR using thecommand line. It contains hvp.properties file.

• HvpWorker.zip — The HVPWorker component. This is the agent that performs the DMSoperations. It contains HvpWorker.war component and hvp.properties file.

• dmei_custom_installer.zip — The Customer Installer used for any customizations of the objectstypes in CS SAP.

For UNIX, download Content_Services_for_SAP_6.5_server_Unix.tar, which contains the followingfiles:

• Enterprise_Integrations_Core.tar

• dmei_webadmin.tar

• dmei_custom_installer.tar

• HvpWorker.tar

• hvps.tar


Installing CS SAP Server Components

Installing Enterprise Integration Core DAR fileThis section provides instructions for installing Enterprise_Integrations_Core.dar files on allDocumentum Composer supported operating system.

Note: Use the information in this section to install other .dar files.

Ensure that the dfc.properties of the composer utility has the Global repository details specified.

The Documentum Composer can be located in the system where content server 6.5 or above isinstalled. In Windows OS, the composer could be located in %DOCUMENTUM%\product\6.5\install\composer on the system where Content Server is installed. Alternatively, the latest versionof the composer can be downloaded from Powerlink®.

Users comfortable with the GUI mode, can make use of the Composer GUI to install DARs. TheComposer GUI is specific to Windows environment. If the Content Server is running on an UNIXenvironment, you could still connect to the repositories from the Composer GUI installed on yourWindows system making the needed changes to the dfc.properties of the composer:

1. Extract the contents of the following to a temporary directory:• Enterprise_Integrations_Core.zip for Windows

• Enterprise_Integrations_Core.tar for UNIX

The temporary directory should now contain the following files:• dmant.bat (Windows)

• dmant.sh (UNIX/Linux)

• DARInstallScript.xml (composer ANT install script)

• install.properties (installation properties)

• Enterprise_Integrations_Core.dar (DAR filename)

2. The Enterprise_Integrations_Core.dar can be installed using the DAR Installer GUI in Windowsenvironments as described in Installing a DAR file using the DAR Installer GUI.Alternatively, the dar file can be installed using the headless composer as described below.

3. Follow the steps below to install the DAR file using the headless composer:

a. Update the install.properties file with the repository name, credentials and the location ofthe DAR file, as follows:• dar.docbase = <repository_name>

• dar.username = <repository_install_owner_username>

• dar.password = <repository_install_owner_password>

• dar.domain = <domain> (optional)

• dar.core.file = <absolute path>

b. The DARInstallScript.xml should have an emc.install ant task for every dar file.



c. Specify the location of the headless composer and workspace in the dmant.bat file:• Set the ECLIPSE environment variable to the Composer Headless directory on yourmachine.

• Set the WORKSPACE environment variable to a clean directory.

For example:echo offsetlocalset ECLIPSE=C:\ComposerHeadlessset WORKSPACE=C:\ComposerHeadless\workspaceset BUILDFILE=%1java -Xmx1024m -XX: MaxPermSize=128m -cp %ECLIPSE%\startup.jar org.eclipse.core.launcher.Main-clean -data %WORKSPACE%application org.eclipse.ant.core.antRunner-buildfile %BUILDFILE%

Note: Ant tasks do not pick up the settings in the eclipse.ini file. This means thoseparameters have to be set on the command line when invoking Java.

For UNIX environments, add -Dlogpath=<path> to the Java command.

d. Run the Ant task, as follows:• For Windows — cd <directory path of batch file and xml file>dmant.bat DARInstallScript.xml

• For UNIX — change sh script mode:$ chmod a+rx dmant.sh

cd <directory path of batch file and xml file>$./dmant.sh DARInstallScript.xml

Installing CS SAP WebAdmin in DocumentumAdministratorTo complete the CS SAP WebAdmin installation:1. Ensure you have completed all of the installation procedures listed earlier in this section before

continuing with this procedure.

2. Extract the content of dmei_webadmin.zip (Windows) or dmei_webadmin.tar (UNIX) to atemporary directory.

3. Copy the dmeiwebadmin folder into the Documentum Administrator (DA) folder created duringthe Documentum Administrator installation.

4. Copy the WEB-INF folder into the DA folder, selecting Yes when prompted to overwrite allthe contents of the existing WEB-INF folder.

5. Copy the theme folder inside the custom folder into the DA\custom folder, selecting Yes whenprompted to overwrite all the contents of the existing theme folder.



6. Open the file DA\Custom\app.xml in a text editor and make the following change:

<application extends="webtop/app.xml”>

to

<application extends="dmeiwebadmin/app.xml”>

7. Close and save the file.

CS SAP WebAdmin is ready for use. The EMC Documentum Content Services for SAP AdministrationGuide has additional information about using CS SAP WebAdmin to administer your system.

Installing the High Volume Processing Server(HVPS)High Volume Processing Server (HVPS) is a parallel processing platform with enterprise classscalability and performance for building services such as:• Policy orchestration

• High volume ingestion

• Indexing

• Data replication

• Store synchronization

Installing HVPS includes:• HVP Controller

This server component is packaged as the hvps.dar file. HVP Controller runs in the realmof the method server and delegates the jobs executed from the WebAdmin to the registeredHVP workers.

• HVP Worker

The HvpWorker.war file can be installed on any supported application server (refer Release notesfor the supported application servers). The jobs delegated by the controller are executed by theHVP Worker. The HVP Worker packages DFC libraries that is used to communicate with therepository. It communicates with SAP using the SAP JCo libraries. The JCo libraries have to bedownloaded from the SAP marketplace into the lib directory of HVP Worker.

Note: The EMC Documentum Content Services for SAP Administration Guide has completeinformation about registering an HVP worker.



Installing the hvps.dar file

The following procedure describes how to install the hvps.dar file on all operating systems:

1. Extract the contents of the following to a temporary directory:• hvps.zip for Windows

• hvps.tar for UNIX

The temporary directory should now contain the following files:• darinstall.bat (Windows)

• darinstall.sh (UNIX/Linux)

• DARInstallScript.xml (composer ANT install script)

• darinstall.properties (installation properties)

• hvps.dar (DAR filename)

• hvp.properties

2. The hvps.dar can be installed using the DAR Installer GUI in Windows environments asdescribed in Installing a DAR file using the DAR Installer GUI.Alternatively, the dar file can be installed using the headless composer.

3. Follow the steps below to install the DAR file using the headless composer:

a. Update the install.properties file with the repository name, credentials and the location ofthe DAR file, as follows:• dar.docbase = <repository_name>

• dar.username = <repository_install_owner_username>

• dar.password = <repository_install_owner_password>

• dar.domain = <domain> (optional)

• dar.name = hvps.dar (DAR name)

b. The DARInstallScript.xml should have an emc.install ant task for every dar file.

c. Specify the JDK path, location of the headless composer, and workspace in the darinstall.batfile:• Set the ECLIPSE environment variable to the Composer Headless directory on yourmachine.

• Set the WORKSPACE environment variable to a clean directory.

For example:echo offsetlocalset JAVA_HOME=C:\"Program Files"\Java\jdk1.5.0_15set ECLIPSE=C:\ComposerHeadlessset WORKSPACE=C:\ComposerHeadless\workspaceset BUILDFILE=%1call %JAVA_HOME%\bin\java.exe -cp %ECLIPSE%\startup.jar org.eclipse.core.launcher.Main-clean -data %WORKSPACE%-application org.eclipse.ant.core.antRunner



-buildfile %BUILDFILE%

Note: Ant tasks do not pick up the settings in the eclipse.ini file. This means those parametershave to be set on the command line when invoking Java.

For UNIX environments, add -Dlogpath=<path> to the Java command.

d. Run the Ant task, as follows:• For Windows — cd <directory path of batch file and xml file>darinstall.bat DARInstallScript.xml

• For UNIX — change sh script mode:$ chmod a+rx darinstall.sh

cd <directory path of batch file and xml file>$./darinstall.sh DARInstallScript.xml

4. To get the HVP Controller logs, copy the hvp.properties file to the directory pointed by theDOCUMENTUM environment variable on the content server system. Edit the hvp.log.base ofthe properties file to get the logs.

Deploying the HvpWorker.war file

The following procedure describes how to prepare the HvpWorker.war file for installation.

To prepare the HvpWorker.war file for installation:1. Extract the contents of the following to a temporary directory:

• HvpWorker.zip for Windows

• HvpWorker.tar for UNIX

2. The temporary directory should now contain the following files:• HvpWoker.war

• hvp.properties

3. Create a directory named HvpWorker.

Note: The directory name is case-sensitive.

4. Copy the HvpWorker.war file to the HvpWorker directory created in step 3.

5. Unjar the file using the following jar command:jar –xvf HvpWorker.war

The war file is extracted to a directory called ’HvpWorker.’

6. Edit dfc.properties file in the HvpWorker/WEB-INF/classes folder as follows:• Type the docbroker hostname. For example:dfc.docbroker.host[0]=100.100.100.100

• Type the docbroker port number. For example:dfc.docbroker.port[0]=1489 optional, default 1489

• Optionally, type the DFC data directory. For example:dfc.data.dir=C:/Documentum



• Type the DFC global BOF registry docbase name [Optional]. For example:dfc.bof.registry.repository= cssap65_dev_HvpWorker

• Type the DFC global BOF registry docbase user name. For example:dfc.bof.registry.username=dm_bof_registry

• Type the DFC global BOF registry docbase user-encrypted password. For example:dfc.bof.registry.password=kBb9DmXB6pQ\=

7. Based on the operating system being used, edit the log4j.properties to have the correct pathfor the following variable:log4j.appender.F1.File=<path_to_logs_dir>/logs/hvpWorker.log

8. Based on the operating system being used, edit the hvp.properties to have the correct path forthe following variable:hvp.log.base=<path_to_logs_dir>/logs

9. Re-create the HvpWorker.war from the temporary folder using the jar –cvf command.

10. Deploy the HvpWorker.war file using the application server procedure appropriate for yourinstallation.

11. To get the HvpWorker logs, copy the hvp.properties file to the directory pointed by theDOCUMENTUM environment variable on the system where the HvpWorker is installed. Createthe DOCUMENTUM environment variable and the folder if it does not exist on the HvpWorkersystem. Edit the hvp.log.base of the properties file to get the worker logs.

Note: If HvpWorker and DA are installed on the same application server, then add thejava.library.path for both. Make sure the SAP JCo dll files is present in both HVPWorker and DAvirtual directories and the java.library.path is specified to each of them.

Deploying HvpWorker.war on Apache Tomcat

To deploy on Apache Tomcat:1. Ensure Apache Tomcat is configured to deploy the HvpWorker.war file in unpacked mode.

This is the Apache Tomcat default setting.

2. Copy the re-jarred HvpWorker.war file to the <Tomcat>/webapps folder.

3. Restart the Apache Tomcat server.

Deploying HvpWorker.war on BEA WebLogic

Follow the steps 1 through 4 in Deploying the HvpWorker.war file and copy all the files to a folder,such as HvpWorker.

To deploy on BEA WebLogic:1. Unjar HvpWorker.war into a directory named HvpWorker, as follows:

jar –xvf HvpWorker.war




2. Start the BEA WebLogic server:http://<ip>:7001/console

3. Type your user ID and password.

The entries are case-sensitive.

The BEA WebLogic server window appears.

4. Click Deployments in the left panel.

5. Click Lock & Edit also located in the left panel.

6. Click Install.

7. Using the Install Application Assistant, locate the HvpWorker directory you created in step 1.

Specifiying the HvpWorker directory installs all components in and below the directory. Forexample:100.100.100.100/export/home0/bea02/softwares

8. Select the HvpWorker directory and click Next.

9. Specify the installation target as "application.”

10. Click Next.

11. Select the servers and clusters, or both, to which you want to deploy HvpWorker.war.

Note: If you have not created additional Managed Servers or clusters, you will not see this page.

12. Click Next.

13. Optionally, accept the defaults for these settings about the deployment, or update them:

• Deployed Web application name.

• Application security model.

• How the source directory contents were made available to targeted Managed Servers andclusters.

14. Click Next.

15. Review the configuration settings you specified:

• app-root

• /app

• /plan

Note: If you install an application that follows this directory structure and there is no deploymentplan in the /plan directory, the WebLogic server automatically creates a deployment plan for you.

16. Click Finish.

If you chose to immediately go to the deployment’s configuration screen, click the tabs to setadditional configuration settings for the Web application. If you chose to change this informationlater, the Administration Console returns you to the Deployments table, which should nowinclude your newly installed Web application.

17. Click Activate Changes in left panel.



This commits all changes made.

Note: Not all changes take effect immediately—some require a restart.

Deploying HvpWorker.war on IBM WebSphere

To deploy on IBM WebSphere:1. Start the IBM WebSphere server. For example:

http://10.31.150.113.9060/ibm/console

2. Type your user ID.

The Integrated Solutions Console screen appears.

3. Expand Applications and click Enterprise Applications.

4. Click Install in the Enterprise Applications panel.

5. Select Local file system if the file is located on a local machine; otherwise select Remote filesystem with context root as cssap.

6. Select the (*) Show me all installation options and parameters and press Next.

7. Accept the defaults in the next screen and click Continue.

8. In the following screen select Precompile JavaServer Pages files and type HvpWorker as theApplication Name. Click Next.

9. In theMap modules to servers screen, select the HvpWorker.war file for the module and clickNext.

10. In the Provide options to compile JSPs screen, type 15 under JDK source level and click Next.

Note: The JDK source level specifies the level at which the Java compiler compiles JSP Javasources. Valid values are 13, 14, and 15. The default value is 13, which specifies source level 1.3.

11. Select JSP enable class reloading and click Next.

12. Select both checkboxes to map shared libraries and click Next.

13. Select to map virtual hosts and clickNext. For Web Sphere Application Server Version 7.0, changethe context root of application to /HvpWorker.

14. Click Finish.

The following message indicates a successful installation:ADMA5013I: Application HvpWorker installed successfully

ClassLoader setting

To complete the installation:1. Browse to Application > Enterprise Applications and click HvpWorker.

2. ClickManage Modules under theModules heading.

3. In the following screen click the HvpWorker hyperlink.



4. In the Class loader order drop-down box, select Class loaded with application class loaderfirst and click OK.

5. In the next screen click Save.

6. In the Manage Modules screen, HvpWorker appears selected in red.

7. Log out and restart the server to deploy HvpWorker.war.

Deploying HVPWorker.war on JBoss

To deploy on JBoss:1. Unjar the re-jarred HvpWorker.war into a directory named HvpWorker, as follows:

jar -xvf HvpWorker.war


2. Rename the ‘HvpWorker’ directory to ‘HvpWorker.war.’

3. Copy the ‘HvpWorker.war’ directory to <<JBOSS_HOME>>\server\default\deploy directory.

4. Restart the JBoss server.

Significant system objects

This section contains information about significant system objects installed during HvpWorker.warfile deployment.

dfc.properties

To allow the HVP worker communication with the HVP controllers, all HVP controllers’ docbrokersmust be added into the dfc.properties file, as follows:# Refer dfcfull.properties for detailsdfc.data.dir=C\:/Documentumdfc.search.ecis.enable=falsedfc.search.ecis.host=dfc.search.ecis.port=

### GR infodfc.bof.registry.repository=<myGRDocbase>dfc.bof.registry.username=dm_bof_registrydfc.bof.registry.password=<encryptedPasswd>dfc.bof.registry.preload.enabled=falsedfc.bof.cacheconsistency.interval=60

### HVP controller docbroker DNS namesdfc.docbroker.host[0]=<mydocbroker1.mycompany.com>dfc.docbroker.port[0]=1489dfc.docbroker.host[1]=<mydocbroker2.mycompany.com>dfc.docbroker.port[1]=1489



log4j.properties

In the properties, HVP worker container log file is specified below, in bold:log4j.rootCategory=WARN, A1, F1log4j.category.MUTE=OFFlog4j.additivity.tracing=truelog4j.category.tracing=WARN

#------------------- CONSOLE --------------------------log4j.appender.A1=org.apache.log4j.ConsoleAppenderlog4j.appender.A1.threshold=WARNlog4j.appender.A1.layout=org.apache.log4j.PatternLayoutlog4j.appender.A1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%n

#------------------- FILE --------------------------log4j.appender.F1=org.apache.log4j.RollingFileAppender## in Tomcat caselog4j.appender.F1.File=${catalina.home}/logs/hvpWorker.loglog4j.appender.F1.MaxFileSize=10MBlog4j.appender.F1.layout=org.apache.log4j.PatternLayoutlog4j.appender.F1.layout.ConversionPattern=%d{ABSOLUTE} %5p [%t] %c - %m%nlog4j.logger.com.documentum.ei=INFO

Note: Change the log4j.logger.com.documentum.ei=INFO to DEBUG if you need detailed logsfor troubleshooting.

HVP.properties

This is HVP worker-specific properties:hvp.log.base=C:\Documentum\logshvp.log.format=%d{DATE} [%-5p] [%t] %c - %m%nhvp.log.level=INFO

Note: Set hvp.log.level=DEBUG for detailed logs.

The hvp.log.base has a path for the Agent activity logs. For example, in Windows:hvp.log.base=C:\Documentum\logs

Postinstallation configurationDownload SAP JCo library version 2.1.8 from the SAP marketplace for the operating system beingused. Copy the sapjco.jar, and the .dll files (Windows) or .so files (UNIX), to the /WEB-INF/libdirectory of the installed CS SAP WebAdmin and HvpWorker application. The following sectionsdescribes the environment variables to be set on the operating system being used.

Setting Windows environment variables

Set the Windows environment variable as follows:• DA and CS SAP WebAdmin



Specify JVM parameter java.library.path=<Application Server-Installation-Directory>\...\<DA–Virtual–Directory>\WEB-INF\lib

• HvpWorker

Specify JVM parameter java.library.path=<Application Server-Installation-Directory>\...\<HvpWorker–Virtual–Directory>\WEB-INF\lib

• If HVPWorker and DA are installed on the same application server, then add the java.library.pathfor both. In this case, make sure the SAP JCo dll files are not copied to the System32 folder andthe following is specified as a JVM parameter.

java.library.path=<Application Server-Installation-Directory>\...\<DA-Virtual-Directory>\WEB-INF\lib;<Application Server-Installation-Directory>\...\<HvpWorker-Virtual-Directory>\WEB-INF\lib

Note: If both DA and HVP Worker are running on the same application server, then thejava.library.path should point to both the WEB-INF/lib directories of DA and HVPWorker.

For example, in Tomcat, edit the catalina.bat file to set:

JAVA_OPTS=%JAVA_OPTS% -java.library.path=C:\Program Files\Apache SoftwareFoundation\Tomcat 6.0\webapps\da\WEB-INF\lib

Note: If the JVM parameter java.library.path is not set, then the .dll files can also be placed inC:\WINDOWS\system32\

Setting UNIX environment variables

Set the UNIX environment variable as shown in the following table:

Table 2. UNIX environment varibles

Variable Value

LD_LIBRARY_ PATH — Solaris shared librarypath

SHLIB_PATH—HP-UX shared library path

LIBPATH — AIX shared library path

1. On the system where DA and CS SAPWebAdmin are running:• If you are using BEA Weblogic,then use the following value:$BEA_HOME/user_projects/domain/<WebLogic-Domain-Name>/<WebLogic-Server-Name>/…/<DA-Virtual-Directory>/WEB-INF/lib

• If you are using IBM WebSphereApplication Server then use thefollowing value: $WAS_HOME/… /<DA-Virtual-Directory>.war/WEB-INF/lib

• If you are using Sun JavaSystem Application Server,then use the following value:$SUN_Application_Server_Home/



Variable Valuedomains/<Domain_Name>/…../<DA-Virtual-Directory>_1/WEB-INF/lib

• If you are using Tomcat, then use thefollowing value: <Tomcat-Installa-tion-Directory>\webapps\<DA–Vir-tual–Directory>\WEB-INF\lib

• If you are using JBOSS,then use thefollowing value: $JBOSS_HOME/server/<Server-Instance>/deploy/<DA-Deploy-Directory>/WEB-INF/lib

2. On the system where HvpWorker isrunning:• If you are using BEA Weblogic,then use the following value:$BEA_HOME/user_projects/domain/<WebLogic-Domain-Name>/<WebLogic-Server-Name>/…/<HvpWorker-Virtual-Directory>/WEB-INF/lib

• If you are using IBM WebSphereApplication Server then use the followingvalue: $WAS_HOME/… /<HvpWorker-Virtual-Directory>.war/WEB-INF/lib

• If you are using Sun JavaSystem Application Server,then use the following value:$SUN_Application_Server_Home/domains/<Domain_Name>/…../<HvpWorker-Virtual-Directory>_1/WEB-INF/lib

• If you are using Tomcat, then use the fol-lowing value: <Tomcat-Installation-Di-rectory>\webapps\<HvpWorker–Vir-tual–Directory>\WEB-INF\lib

• If you are using JBOSS, then use thefollowing value: $JBOSS_HOME/server/<Server-Instance>/deploy/<HvpWorker-Deploy-Directory>/WEB-INF/lib



Customization using dmei_custom_installerutilityContent Services for SAP supports customization of SAP query types and SAP object types.

Note: The custom.xml is supported only on SAP R/3 or ECC systems.

To enable customization:1. Browse to the directory where you extracted the contents of the CS SAP installer archive.

2. Extract the contents of dmei_custom_installer.zip into a temporary folder.

3. Open the custom.xml file in the text editor or the XML editor for editing.

4. Locate the dfc.properties file in the temporary folder, and edit the file with the DocumentumFoundation Class directory information and docbroker information (dfc.docbroker.host anddfc.docbroker.port).

5. Locate the installer.properties file in the temporary folder and edit the file with the informationshown in the following table:

Table 3. Installer properties file values

Value Definition

user.language The default is en_US (English).

docbase.name Name of the repository that you want toconfigure.

docbase.user.name Type repository install owner name.

domain Name of the domain in which the repositoryis located.

custom.xml.path The custom XML file path.

6. Locate the log4j.properties file in the temporary folder and edit to change the directory locationof the log files.

Note: By default, log files are generated in the current (temporary) folder.

7. Issue the following command from the command line to run the custom XML file installer:java -jar dmei_custom_installer.jar

Note: The file dmei_custom_installer.jar is in the temporary folder where you extracted thecontents of the dmei_custom_installer.zip file.

8. Type the password for the repository specified in the installer.properties file.

File processing begins and the following message appears when processing completes:Processing Successfully Completed!

Note: If the following message appears, look in the log files to determine the problem with thecustom.xml file installation:Processing Failed!



You have now customized values for sap_query_type_plm query types and object types. Thecustomized values that you configured here are accessible from the Rule Composer section of theLink Documentum and Replicate Documentum nodes in WebAdmin.




Chapter 3Installing CS SAP client components

This chapter describes procedures required to install the client components of CS SAP:• View

• Manage

Obtaining current version software from theDocumentum Download CenterTo ensure that you install the current version of this product, visit the EMC Download Center athttps://EMC.subscribenet.com and review the product versions available for your platform.

Download Content_Services_for_SAP_6.5_client.zip, that contains the following files:• ClientInstaller.zip

• webview.zip

System configuration and dependenciesCS SAP is an integrated suite of products that provide document management, imaging, andarchiving services. Services can be installed on different physical machines in different locationsas long as the required functional components for each specific service are on the same machine.The following table provides an overview of possible system configurations and the functionalcomponent dependencies for each service or function.

Table 4. System configuration and dependencies

System configuration Functional component dependencies (must beon same physical machine)

Browser enabled viewing client — Viewdocuments by selecting a link in SAP GUI.

SAP GUI plus View — Installed with Webtopintegration

OLE viewing client — View documents byselecting a link in SAP GUI or by calling a DRLdirectly from the repository.

SAP GUI plus View


Installing CS SAP client components

System configuration Functional component dependencies (must beon same physical machine)

OLE viewing client — View documents bycalling a DRL directly from the repository.

View

SAP DMS Linking — Links Documentumdocuments to SAP equipment, material,functional location, customer, vendor, WBSelement, or document info record.

View plus Manage

User roles and client componentsThe client components of CS SAP are installed according to the role of the user. These definedroles are:

• Administrator

This role covers those who release documents to SAP and maintain the links to those documents.They will have access to the View and Manage components of CS SAP.

• Standard User

This role covers users who want to view documents that are archived in the EMC Documentumrepository. They will have access to the View component of CS SAP.

Note: TheManage component is launched directly from the View component. However, if CS SAPis installed using the Standard User installation option, the Manage menu will not be accessible.

Installation prerequisitesInstallation prerequisites include:

• Windows 2000 Server, Windows 2003 Server, or Windows XP Professional.

• Internet Explorer 4.x/5.x or later or Netscape 4.x is required for WebView (does not work onNetscape 6).

• SAP GUI.

• Each user should have user account in SAP and in the repository that is integrated with SAP.

• If a DMCL.INI is present on the client PC, make sure it is in the WINDOWS or WINNT directory.

• Content Services users should be "Power users” on the Windows operating system, not "Restrictedusers.” Restricted users attempting to use Content Services components will get an errorindicating that the registry cannot be accessed or update.



Customizing installationTo change your client installation you must modify the setup.ini file. You can specify installcomponents and install directories and also the formats to be used by document types. If you do notspecify your requirements, the defaults will be used.

By default, the View component is installed into the SAP directory. In the past, it was typicallyinstalled into C:\DMVIEW. If you want to install into C:\DMVIEW, you will need to edit theinstaller SETUP.INI file to set the entry viewdir in the [Install] section to your required directory.Alternatively, change your SAP application setting to remove the application path for DmView.

Similarly, if you want to change the Windows default application used to open particular documenttypes (Notepad to open .TXT files for example), you will need to edit the SETUP.INI.

Document types can be customized at the client stations through the View component.

Use the setup.ini file if you want to apply the same defaults across multiple client workstations.

Following is an example of the setup.ini file:SETUP.INI

[Startup]

AppName=External Viewing Services for SAP

FreeDiskSpace=483

EnableLangDlg=Y

[ISUPDATE]

UpdateURL=http://

# Installer Version External Viewing Services 5.3 SP1 Docbase Version 1.2

# ------------------------------------------------------------------------------

# Section: Install

# ------------------------------------------------------------------------------

# This section allows you to specify install components and install directories

# For example, you can specify

# [Install]

# view=1

# webview=1



# viewdir=c:\dmview

# To install View into c:\dmview

# The install component settings are only used if the install is run silently

# You can run a silent install by running "setup /s"

# [Install]

# view=0 or 1

# manage=0 or 1

# webview=0 or 1

# capture=0 or 1

# archiveview=0 or 1

# targetdir=a directory

# viewdir= a directory

[Install]

# ------------------------------------------------------------------------------

# Section: Formats

# Use this section to specify format preferences for viewing specific document

# types. For example

# [Formats]

# crtext=notepad %s

# will view text files using notepad. The key name should correspond to a

# Documentum format type.

# ------------------------------------------------------------------------------

[Formats]



Installing CS SAP Client ComponentsTo install CS SAP:

1. Download and unzip the current release of CS SAP installation files to a temporary directory onyour local machine.This URL will take you to the Download Center login page where you can download the latestversion of CS SAP: https://EMC.subscribenet.com. Your default login ID is your email address. Ifyou cannot locate your password, use the password finder at the bottom of the login page.

Note: Make sure the folder in which you unzip the release does not have any of thefollowing special characters: ! \ / : * ? " < > |. For example, if the full path to the installer isC:\Downloads\!Documentum\NewRelease\ Content_Services_sap\server\setup.exe, theinstallation may fail because of the ! in the folder name.

2. Navigate to ..\Content_Services_sap\client\setup.exe in the directory where you unzippedthe release.

3. Double-click setup.exe.TheWelcome screen appears.

4. Click Next.The Select Components screen appears.

5. Select your preferred language.

6. Click Next.The Setup Type dialog box appears.

7. Select the client component to install:• Administrator Installation

Installs the View, and Manage components of Content Services.

• Standard User Installation

Installs the View component of Content Services.

8. Click Next.The Choose Destination Location dialog box appears.The default destination folder where the components will be installed will be C:\ProgramFiles\Documentum\DocLink. If you want to change this, use the Browse button to navigate tothe required folder and double-click on the folder name. SAP interfaces must be able to locatethe View component; usually, the SAP GUI default directory is the best location. The defaultdirectory for the View, and ArchivelinkView is C:\Program Files\SAPpc\sapgui, which is theresident directory for SAP GUI.

Note: ArchiveLink expects dmview to be found in the SAP GUI directory. If these programs aremoved, ArchiveLink may not function as expected from SAP GUI. Also, dmview is used by bothArchiveLink and DMS interfaces. These paths are configured separately in SAP. Unless multiplecopies of dmview exist, the path must match the path configured in both ArchiveLink and DMS.The SAP configuration manual provides more information.

9. Click Next.

10. To use WebTop as the default viewer, select the Display Using WebTop checkbox.


https://emc.subscribenet.com


To use WebView as the default viewer, select the Display Using WebView checkbox.

11. Click Next.

12. Type the URL to your WebTop or WebView installation. The convention for the Webtop orWebView URL is http://<localhost>: <port number>/webtop/component/drl, where:• <localhost> is the name of the host on which the WebTop or WebView installation is running.

• <port number> is the appropriate number.

13. Click Next.The Start Copying Files dialog box appears, displaying the settings that you have chosen.

14. Click Next.

15. The files are copied and the installation is completed.The Setup Complete dialog box appears.

16. Click Finish.

Configuring WebView

To prepare the web application server to support WebView:1. Shut down the web application server that will support WebView.

2. Deploy wdk.war to that web application server.

The wdk.war file is in the temporary directory where you downloaded and unzippedwebview.zip.

3. Locate the dfc.properties file in the wdk/WEB-INF/classes folder.

4. Edit the dfc.properties file with your docbase login parameters. For example:

dfc.docbroker.host[0]=<myDocbroker>

dfc.globalregistry.repository=<myGRDocbase>

dfc.globalregistry.username=<userName>

dfc.globalregistry.password=<encryptedPasswd>

5. Restart the web application server.

Installing Daeja ViewerOne Pro version 1.1.80

Daeja ViewerOne Pro version 1.1.80 is not delivered with WebView, but is compatible with WebViewand supports the following formats:• PDF

• Tiff

• JPEG



• BMP

• GIF

To use the Daeja plug-in, download and install the plug-in from the Daeja website at:http://www.daeja.com/

Follow the website instructions for installing the plug-in.

To enable WebView to use the Daeja plug-in:1. Shut down the web application server that supports WebView.

2. Locate the dmei_webview-unobfs.jar file in the wdk/ WEB-INF/lib folder.

3. Open the webview.properties file that is in the dmei_webview-unobfs.jar file.

4. Set the following parameter from false to true:DaejaViewer = true

Note: By default, the DaejaViewer parameter is set to false.


Installing the image services .dar file

You must install the image_services.dar file for WebView and the Daeja plug-in to work correctlytogether.

Note: To avoid exception in the log, the dar file has to be installed on the global repository also.

Use the installation information in Installing a DAR file using the DAR Installer GUI as guidance toinstall the image_services .dar file.

Configuring the View component for Webtop orWebViewTo configure the View component so that you can view and edit content using Webtop or WebView:

1. Install CS SAP.

2. Launch the View client using Start > Programs > EMC Documentum Content Services forSAP > View.

3. Select Edit > Preferences.You will be prompted to log in to a repository.

4. Select the repository configured for CS SAP.

5. Select a document format type, for example, Microsoft Word or FOLDER (at the end of the list).

Note: WebView supports the following formats:• PDF

• TIFF

• GIF



6. Select the View Using Webtop or View Using WebView.

7. Click Apply.

Configuring Brazilian Portuguese Language Pack forWebView

To enable Brazilian Portuguese support for WebView:

1. Shut down the web application server where WebView is installed.

2. Unzip WebView_Language_Pack_Portuguese_pt_BR.zip to a temporary directory.

3. Copy the unzipped contents to <application_server_home>/webapps/wdk.

4. Update the language element in <application_server_home>/webapps/wdk/app.xml by addingBrazilian Portuguese locale support in the supported locale section (shown in bold text):<language><supported_locales>

<locale>en_US</locale><locale>pt_BR</locale>

</supported_locales>


6. Install the Brazilian Portuguese data dictionary in the docbase as described in the EMCDocumentum Content Server documentation.

Configuring Korean Language Pack for WebView

To enable Korean support for WebView:

1. Shut down the web application server where WebView is installed.

2. Unzip WebView_Language_Pack_Korean_ko_KR.zip to a temporary directory.

3. Copy the unzipped contents to <application_server_home>/webapps/wdk.

4. Update the language element in <application_server_home>/webapps/wdk/app.xml by addingKorean locale support in the supported locale section (shown in bold text):<language><supported_locales>

<locale>en_US</locale><locale>ko_KR</locale>

</supported_locales>


6. Install the Korean data dictionary in the docbase as described in the EMC Documentum ContentServer documentation.



Silent installation

You may want to roll out a particular client install across several workstations. This is what is knownas a "silent" install. One important requirement is that the installation is identical from workstation toworkstation. For example, if the installer detects a file and displays a dialog box, you must ensurethat the same file is detected on all workstations using that silent install file (for example, DMCL.INI).If not, the order of, and perhaps responses to, the dialog boxes will change.

To run a silent installation:

1. Ensure no previous installation exists.

2. Before you start, end the dmapi.exe from the Task Manager or Close Programs window (pressCtrl + Alt + Delete to open the window).

3. Run a sample installation with the following command line option:"setup -r".

This creates an installation script in the windows directory (C:\WINNT or C:\WINDOWS). Thename of the script is "setup.iss". Make sure the client machines are identical to the recordingmachine. For instance, if you know that the client machines where the silent install will beperformed do not have a dmcl.ini file, then you should not have a dmcl.ini file on the machinewhere you are creating the recording file. The environment should be exactly the same. If theenvironments are not the same, you will get resultcode=-12 in the setup.log, which means thedialog box order has changed.This file records the installation dialog boxes in sequence. Do not click the dialog box Backbuttons during the installation. Whatever options are chosen (for example, the docbroker) will beused during all the silent installs. You can open the file and view the options.

4. Copy "setup.iss" into the setup kit (from where you run "setup.exe").

5. To test on the same machine, end the dmapi.exe and uninstall any client software. Run silentinstaller: Run "setup -s".Other meaningful result codes in the log file include:• 0 Success.

• -1 General error.

• -2 Invalid mode.

• -3 Required data not found in the Setup.iss file.

• -4 Not enough memory available.

• -5 File does not exist.

• -6 Cannot write to the response file.

• -7 Unable to write to the log file.

• -8 Invalid path to the InstallShield Silent response file.

• -9 Not a valid list type (string or number).

• -10 Data type is invalid.

• -11 Unknown error during setup.



• -12 Dialog boxes are out of order.

• -51 Cannot create the specified folder.

• -52 Cannot access the specified file or folder.

• -53 Invalid option selected.

Postinstallation tasks

Disabling tag pooling for WebView

WebView does not support tag pooling. To disable tag pooling for all web applications on theTomcat instance:1. Add the following lines to the <servlet> element in the <Tomcat Install Directory> \conf\web.xml

file:<init-param><param-name>enablePooling</param-name><param-value>false</param-value></init-param>

2. Delete the cache from:..\ work\Catalina\localhost

3. Restart the Tomcat server.


Chapter 4Upgrading CS SAP

Before upgrading CS SAP, depending on existing infrastructure and your needs, you shoulddetermine how you want to deploy the application in your enterprise.

Upgrading the CS SAP serverThis section lists the upgrade procedures for CS SAP 5.3 SPx, CS SAP 6.0, and CS SAP 6.0 SP1.

Note: The default action configurations, Server and User configurations that come with CS SAP areoverwritten whenever a newer version or a patched version of the Enterprise Integrations CoreDAR is installed.

Any customizations done to the existing object model using custom.xml or manually through DAwill have to be executed again after upgrading.

For example, customizations done to Document Info Record PLM object, using custom.xml, in 5.3 SPxor 6.0 SPx or 6.5 SPx will have to be repeated after upgrading to the latest version.

Upgrading from CS SAP 5.3 SPx server

You can upgrade directly from CS SAP 5.3 SPx to CS SAP 6.5:

1. Make sure there are no pending agent jobs. Deactivate jobs and reactivate the jobs upon upgradecompletion.

2. Stop Windows IIS Service.

3. Uninstall the existing software using Microsoft ADD/REMOVE programs, as follows:

a. Log off of and close all Content Services applications.

b. Stop all Content Services for SAP services (AGENT and RFC).

c. Open Control Panel > Add/Remove Programs.

d. Remove Documentum Content Services for SAP Server Components.

e. If you receive messages stating that DLLs are in use, open the Task Manager and end them asindicated in the message. If something is still preventing removal of the programs, rebootthe server and try again.


Upgrading CS SAP

f. After you have run the uninstaller, you must navigate to the server installation directoriesand manually delete any leftover files.For example, the Doclink folder, which is installed in the Documentum folder in the serverinstallation directory.

4. Install the server software as directed in this guide.

5. Clear the Documentum cache on the Content Server system, restart the repository, and methodserver.

Note: Installing EI Core DAR throws a warning which can be ignored.

Upgrading from CS SAP 6.0, 6.0 SP1 server

You can upgrade directly from CS SAP 6.0 and 6.0 SP1 to CS SAP 6.5:

Note: Do not try to install custom configuration using Application builder (docapp installation)because the DocApp automatically installs some TBOs and even though they will be replaced bythe DAR file installation they will still be in use, which will cause the jobs to fail. Instead use thedmei_custom_installer tool or Documentum headless composer.


2. Stop Windows IIS Service.



b. Stop all Content Services for SAP services (AGENT and RFC).

c. Open Control Panel > Add/Remove Programs.

d. Remove Documentum Content Services for SAP Server Components.

e. If you receive messages stating that DLLs are in use, open the Task Manager and end them asindicated in the message. If something is still preventing removal of the programs, rebootthe server and try again.

f. After you have run the uninstaller, you must navigate to the server installation directoriesand manually delete any leftover files.For example, the Doclink folder, which is installed in the Documentum folder in the serverinstallation directory.

4. Delete the dependency and bof modules that were installed by CS SAP 6.0 or 6.0 SP1 docapp at/System/Modules by logging into the repository using Documentum Administrator:

a. Execute the following query:-select * from dmc_java_library where object_name=’dmei_core_lib’-select * from dmc_java_library where object_name=’dmei_doclink_lib’-select * from dmc_java_library where object_name=’hvps_lib’

Note: Record the r_object_id of the above folders.


Upgrading CS SAP

b. Execute the following query to remove any dependencies:-delete dm_relation objects where parent_id=’<r_object_id for each of the above 3 folders>’

c. Delete the three folders listed in step 4a manually or by executing the following DQL:-delete dmc_java_library objects where object_name=’<folder_name>’

Note: All the subfolders and their files must be deleted first. The folders will be at thefollowing locations:Cabinets/System/Modules/com.documentum.ei.doclink.task.ExecuteQueryCabinets/System/Modules/com.documentum.ei.doclink.task.MapAttributes

d. Delete the com.documentum.ei.doclink.task.ExecuteQuery and com.documentum.ei.doclink.task.MapAttributes folders from Cabinets/System/Modules folder.

5. Install Enterprise_Integrations_Core.dar and the server software as directed in this guide.

6. Clear the Documentum cache on the Content Server system, restart the repository, and methodserver.

Upgrading from CS SAP 6.5, 6.5 SPx server

Upgrading from CS SAP 6.5, 6.5 SPx server to the latest version of service packs involves thefollowing steps:


2. Stop the application server on which CSSAP WebAdmin and HvpWorker.war are being run, andthen delete the DA and HvpWorker application.

3. Install Enterprise_Integrations_Core.dar and the server software as specified, in this document.

4. Clear the Documentum cache on Content Server system, restart the repository and method server.

Note: Ensure the Composer used to install the DAR files matches the version of the CS SAP servicepack being installed.

When a new version of the Enterprise Integrations Core DAR file is installed, the default actionconfigurations, agent configurations, Server and User configurations bundled with CS SAP areoverwritten.

Upgrading CS SAP client componentsYou can upgrade directly from CS SAP 5.3 SPx, 6.0 and 6.0 SP1 to CS SAP 6.5 SPx:

1. Ensure DMAPI.exe is stopped using the Task Manager or Close Programs:

a. Press Ctrl + Alt + Delete.

b. Locate and highlight the DMAPI.EXE program.

c. Click End or End Task.


Upgrading CS SAP



b. Open Control Panel > Add/Remove Programs.

c. Remove Documentum Content Services for SAP Client.

d. If DmView.exe was manually copied to a directory other than the default installationdirectory after the client installation, make sure these files are deleted before reinstalling thenew clients. The Installshield uninstaller will not remove these files during the uninstall.

3. After running the uninstaller, navigate to the CS SAP installation directories and manuallydelete any leftover files.

4. If the dmview file was moved after installation, the uninstaller will not remove this file. Ensureyou remove this file before upgrading CS SAP clients.

5. Install client software as directed in this guide.

Note: When using the CS SAP client installation program to upgrade an existing clientinstallation, make sure DMAPI.EXE is stopped.


Chapter 5Testing the Installation

The WebAdmin tool is used to set up and run an SAP query in order to test the SAP connection.The EMC Documentum Content Services for SAP Administration Guide has full details on using theWebAdmin tool.

After installing CS SAP, test the installation with the procedures included in this chapter.

Logging in to WebAdmin through DocumentumAdministratorLog in to Documentum Administrator before using WebAdmin to configure CS SAP.

Note: The EMC Documentum Documentum Administrator User Guide has complete information aboutusing Documentum Administrator.

To connect to WebAdmin through Documentum Administrator:1. Start a web browser on a client machine.

2. Connect to the following URL, where <host> is the host where Documentum Administrator isinstalled and <portnumber> is a port number provided during application server installation:

http://<host>:<portnumber>/da/

3. Type your login name and password on the Documentum Administrator Login page.

4. Select a repository from the list box.

If you change the repository, retype your password.

5. In the Location list (if available), select the location on your organization’s network from whichyou are accessing Documentum Administrator.

This allows you to access content from the nearest storage area in the network. Depending onyour organization’s setup, this location might be a fixed value.

6. To view additional options, clickMore Options:• To connect to the repository using a particular server, select that server from the Server listbox.The default is Any Running Server.

• If the repository is running in domain-required mode, type the domain name.

• To set the session locale to another language, select the language from the list box.


Testing the Installation

Note: Do not click the Additional Accessibility Options link on the login page. DocumentumAdministrator does not support the accessibility options.

• To change your password in a repository, click Change Password, select a repository, and typeyour old and new passwords, and then click Change Password.

Note: If LDAP user authentication is used, you cannot change your password from this page.A system administrator must change your password on the LDAP server.

7. Click Login.

The System Information page appears with information about the system.

The EMC Documentum Documentum Administrator User Guide has complete information aboutusing Documentum Administrator and logging in to repositories available in DocumentumAdministrator.

Configuring the SAP serverTo create, view, or edit connections to an SAP server:

1. Connect toWebAdmin, as described in Logging in to WebAdmin through DocumentumAdministrator.

2. Click to expand the SAP subnode and select the Server subnode.

The SAP Server screen appears.

3. Select File > New > SAP Server from the menu at the top of the SAP Server screen.

The New SAP Server screen appears.

4. Type a name for the Server in the New Server’s Name: field.

5. To log in to an SAP server type the hostname or IP address for the server. When an SAP router isused, fill in the complete SAP router string in the following format:/H/router1/H/<host_name_or_IP_address>

6. If you want to log in to an SAP group, which is associated with an SAP R/3 or ECC server, selectEnable load balancing and type the <SAP_group> in SAP Logon group field.

Note: For SAP Server, enable load balancing configuration for Windows OSwe need to add an entry "sapms<SID>3600/tcp # SAP System Message Port” inC:\WINDOWS\system32\drivers\etc-> services file. This entry should not be added at the endof the file, instead add it somewhere in between like just before sapdp00 3200/tcp.

This file should be edited on the system where CS SAP WebAdmin is running.

Also, try restarting the system if the changes do not work.

7. Type the system name and number in the appropriate fields.

8. Click OK to save the SAP server configuration.



Configuring an SAP userTo create, view or edit an SAP user:


2. Click to expand the SAP subnode and select the User subnode.The SAP User screen appears.

Note: To enable worklist and links creation in CS SAP WebAdmin, the recommendedauthorization profiles for SAP users are:• SAP_ALL

• SAP_NEW

3. Select File > New > SAP User from the menu at the top of the SAP User screen.The New SAP User screen appears.

4. Type the username in the Name: field.

5. Type the SAP username in the SAP User Name: field.

6. Type a password for the user.

7. Type the client number.

8. Click OK to save the SAP user configuration.

Creating an SAP queryTo create, view, or edit a new query:


2. Click to expand the SAP subnode and select the Query subnode.The Query screen appears.

3. Select File > New > SAP Query from the menu at the top of the Query screen.The New SAP Query screen appears.

4. Type the query name in the Query Name: field.

5. Select an SAP query type from the SAP Query Type: list box. Your choices are described inthe table below.

Note: With CAD Interface queries, you can only query SAP R/3 version 4.6c. The PLM Interfaceenables you to query SAP R/3 version 4.7 and 4.6c.



Table 5. Query types

Old interface query types (for SAP R/3version 4.6c)

New interface query types (for SAP R/3version 4.7 and 4.6c)

Document info record No Object PLM (Formerly Document inforecord)

Equipment by short text Equipment by short text PLM

Functional location by text Functional location by text PLM

Material by description Material by description PLM

Note: The material by description PLM querytype has three query conditions:• MATERIALSHORTDESCSEL_low

• MATERIALSHORTDESCSEL_Sign

• MATERIALSHORTDESCSEL_ Option

All three query conditions are required if thequery is to return a result.

Archive data Archive data

Cost center Cost center

Financial document Financial document

Personnel links Personnel links

Personnel master Personnel master

Purchasing document Purchasing document

Customer Customer Table PLM

Print list Print list

Vendor Vendor Table PLM

WBS Element WBS Element PLM

Asset Master Asset Master GetList PLM

6. Build the query condition.For each query condition to be defined:

a. Select a parameter from the Query Condition composer: list box and type a value for theparameter in the text box.

b. Click the down arrow to add the parameter and value to the Query Condition: field.

Note: Highlight an entry in the Query Condition field and click x to delete an entry.

c. Continue to select parameters and enter values to build the query condition.

Note: The conditions are AND linked.

7. Click OK to save SAP Query configuration.The Query screen reappears with the newly created SAP query.



Testing an SAP queryTo test the query:


2. Click to expand the SAP subnode and select the Query subnode.The Query screen appears.

3. Select the SAP query for testing.

4. Select File > Test from the menu at the top of the Query screen.The SAP query test fields appear.

Note: Leave the default selections in the list boxes.

5. Click Test.If the connection is made, a list of SAP data appears. If the connection fails, review yoursettings in WebAdmin for SAP Server and SAP User. Make sure that they identically match thesettings used to connect to SAP using a SAP GUI logon session. Also ensure that the minimumconfiguration steps were carried out for SAP DMS.

Configuring an AgentTo configure an Agent, you will need a previously configured Action as well as a previously definedSAP Server and SAP user. For Action configuration refer EMC Documentum Content Services forSAP Version 6.5 Administration Guide

To create, view, or edit an Agent:

1. Connect to WebAdmin. See Logging in to WebAdmin through Documentum Administrator.

2. Click to expand the Auto Manage subnode and select the Agents subnode.The Agents screen appears.

3. Select File > New > Agent from the menu at the top of the Agent screen.The New Agent screen appears.

4. Enter a name for the Agent in the New Agent Name: field.

5. Select the SAP system type from the SAP System Type: drop-down list.

6. Select the action required by the Agent from the Action: drop-down list.

7. Select the SAP server where the Agent is running from the SAP Server: drop-down list.

8. Select the SAP user with the rights to run the Agent from the SAP User: drop-down list.

9. Click OK to save the Agent configuration.



Registering an HVP workerTo register HVP worker:


2. Click to expand the Auto Manage subnode and select the HVPS subnode.The HVPS screen appears.

3. Select File > New > Register HVP Worker from the menu at the top of the HVPS screen.The New Register HVPS Worker screen appears.

4. Enter a name for the Worker in the Name: field.

5. Enter the web address for the Worker in theWorker URL: field as:http://<host>:<port>/HvpWorker/hvpCommand/

orhttp://<host>:<port>/HvpWorker/hvpCommand

6. Select Is Available: if required.

7. Click OK to save the Worker registration information.

Configuring CS SAP jobTo configure a Job, you will need a previously configured Agent.

To create, view, or edit jobs:


2. Click to expand the Auto Manage subnode and select the Jobs subnode.The Jobs screen appears.

3. Select File > New > SAP Job from the menu at the top of the Jobs screen.The New Job screen appears with four tabs across the top.

4. In the Info tab:

a. Enter a job name in the Name: field.

b. Enter a job type in the Job Type: field.

c. Select a trace level for the job in the Trace Level: list box. The trace level detail depends onthe log level set in the hvp.properties of the HVP Worker.

d. Select Active or Inactive, if required.

e. Select Deactivate upon failure, Run after Update, or Save if invalid, if required.

f. Click Next or Schedule to continue the job configuration.

5. In the Schedule tab:



a. Select a job start date and time with the Start Date And Time: calendar pop-up and timelist boxes.

b. Select a metric for job to repeat in the Repeat: list box.

c. Enter how often the job will repeat in the Frequency: list box.

d. Select a job end date and time with the End Date And Time: calendar pop-up and time listboxes, or enter a specific number of time for the job to run.

e. Click Next to continue the job configuration.

6. In the SAP Job tab:

a. Select job agents from the Agents: list box.

b. Click Add to add the agent to the Agents to Run field.Use the up and down arrows to adjust the order that agents run.

7. Click Finish to save the Job configuration.The newly created job appears in the Jobs screen showing the job Object Name, job Last Run,current State, and Status of the job.

8. Right-click on the desired job and select:

a. Run - To immediately run the job.

b. Refresh - To refresh the Jobs screen.

c. View Trace File - To view a report based on the trace level set for the job run.

d. Delete - To delete the job and all its settings.




Chapter 6Uninstalling CS SAP

This chapter describes the procedures required to uninstall the CS SAP server and client components.

Note: Uninstalling does not remove folders and files that were created after the initial installation.Uninstalling does not remove cabinets, folders, or data from the Documentum Content server. Thistask can also be accomplished manually.

Uninstalling CS SAP server componentsNote: The operation of uninstalling CS SAP is not recommended for a production repository. It isincluded here for test and development activities that require a refreshed repository.

To uninstall 6.5 version of CS SAP from host server follow the standard uninstallation procedure asdescribed by the respective application server.

This procedure only deletes programs. To remove the Content Services configuration objects or SAPlinked objects from the repository, use the instructions in the next section, ’Deleting default SAPconfiguration information or data.’

Deleting default SAP configuration information or dataNote: This operation is not recommended for a production repository. It’s included here for test anddevelopment activities that require a refreshed repository. If deletion will include objects that arelinked to SAP, the links must be removed from both SAP and the repository before deleting thoseobjects. Not doing so will cause corruption of the SAP or Documentum databases. The proceduresfor removing links varies according to the type of link and the SAP interface used (Incomingdocuments, Outgoing documents, Print Lists, Data Archiving, Automated linking, DocumentManagement linking).

To delete the default SAP configuration information or data:

1. Log in to the repository using repository owner username.

2. Delete the SAP cabinet (where the example data is stored).

3. Locate and delete any other locations where SAP data has been stored.

Note: SAP data can be stored outside of the SAP cabinet. The SAP cabinet is just the locationrecommended by the default configurations.


Uninstalling CS SAP

4. Delete the Doclink folder located under the System cabinet (where all of the SAP WebAdminconfigurations are stored).

Uninstalling CS SAP client componentsStopping dmapi.exe to release any existing programs from use, or you will receive errors indicatingthat files are in use.

To stop DMAPI.EXE:

1. Press Ctrl + Alt + Delete to open the Task Manager or Close Programs window.

2. Locate and highlight the DMAPI.EXE program.

3. Click End or End Task.

To remove CS SAP client components:

1. Log in as a member of the administrator group to the machine where CS SAP is installed.

2. From the Control Panel, use Add/Remove Programs and select Documentum Content Servicesfor SAP Client.

3. Click Remove.

4. Check to see that dmview.exe was removed from the SAP GUI directory (default locationis <Root–Directory>:\Program Files\SAP\ForntEnd\SapGui). This is the default installationdirectory for DmView.

Note: If these files have been copied or moved to another directory, they must be removedmanually.

The references should now be deleted from the Start > Programsmenu.

5. Open REGEDIT, navigate to HKEY_LOCAL_MACHINE> SOFTWARE> Documentum, anddelete the Documentum Content Services for SAP Client registry key.

6. Restart your computer.


Appendix A

Installing a DAR file using the DARInstaller GUI

You can use the DAR Installer GUI to install a DAR file to a repository if you do not want to use theinterface within Composer.

Note: The Dar Installer GUI is only supported for Windows environment.

The DAR Installer GUI requires Composer to be installed, but does not launch the full ComposerIDE. The DAR Installer GUI is useful in cases where you want to de-couple the development of DARfiles from the installation of DAR files. It is also useful in situations where installation of DAR files isrequired as part of a deployment process. When you open the DAR Installer GUI, it creates threefolders in your Composer installation directory:

• darinstallerconfig — Contains configuration files for the DAR Installer GUI

• darinstallerlogs — Default location of the log files

• darinstallerworkspaces — Workspaces that are created and used by the DAR Installer GUI.The DAR Installer GUI does not delete these workspaces automatically, so you occasionallyneed to clean up 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 (*). Allother fields are optional. The following table provides a description of the fields for the DARInstaller Plugin..

To install a dar file:

1. Download the DAR Installer zip file. You can find the DAR Installer by going to https://EMC.subscribenet.com/control/dctm/search and searching for "Composer” to reach the DocumentumComposer download site. Documentum Headless Composer GUI is available within the CSinstallation also at C:\Documentum\product\6.5\install\composer\ComposerHeadless.

2. Unzip the DAR Installer zip file to the root of your Composer or headless Composer installationdirectory.

3. Run darinstaller.exe, which is located in the Composer root directory, to start the DAR InstallerGUI.

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


https://emc.subscribenet.com/control/dctm/search

https://emc.subscribenet.com/control/dctm/search

Installing a DAR file using the DAR Installer GUI

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

6. In the Repository Details section, specify values for the fields and click Install to install theDAR file to the repository.

You can view the log for the DAR installation by selecting the log file from the Log File list boxand by clicking Open.

Table 6. DAR Installer fields

Parameter Required Description

DAR Yes The absolute file path to the.dar file that you want to install.The file path cannot containany I18N characters or theinstallation will fail.

Input file No The absolute file path to theinstall-based parameter file.

Local folder No The absolute file path tolocalized .properties files.If you want to make yourapplication available in otherlanguages, you need to localizethe project data such as labels,tabs, and descriptions.

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

Connection Broker Host Yes The address of the ConnectionBroker.

Connection Broker Port Yes The port of the ConnectionBroker Repository.

Repository Yes The name of the repository thatyou want to install the DAR fileto. Click on the Connect buttonafter entering the Docbrokerhost and port to retrieve theavailable repositories.

User name Yes The login name for therepository.



Password Yes The password for logging intothe repository.

Domain No The domain where therepository resides.




Appendix B

Troubleshooting

Refer to the EMC Documentum Content Services for SAP Version 6.5 Administration Guide fortroubleshooting information.


Troubleshooting


Index

Aadministration installation, 35

Cconnecting, 45Content Services for SAP administrator, 7create, 47creating an Agent, 49

Ddefault application, 33destination folder, 35dfc.properties, 24

path in UNIX, 24path in Windows, 24

directory for SAPGUI, 35document, 33document controller, 7, 32

Eediting an Agent, 49

Fformat preferences, 33

Hhvp.properties, 25

Iinstall, 31, 33, 35installing

on Windows, 16Solaris, 16

intended audience, 7

LLog4j.properties, 25

Mmaintaining links, 7

Pprerequisites

system administrator, 7

Rregister an HVP worker, 50releasing documents to SAP, 7

SSAP, 45SAPGUI, 35significant system files, 24standard, 32, 35standard user, 7system administrator, 7

prerequisites, 7system files, significant, 24

Ttesting

the SAP connection, 45

Uuninstall, 53user roles, 7

Vviewing an Agent, 49


Index

WWebAdmin, 45

Documents

EMC Documentum ContentServicesforSAP Version6.5 ... SAP-relatedissues,suchasemptyorwronglyconfiguredtables ... DMS-relatedOSSNotesandpatchespriortoCSSAPinstallation