EMC Documentum Archive Services for SAP

Transcription

1 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide P/N Rev A04 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 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. Copyright 2010 EMC Corporation. All rights reserved.

3 Table of Contents Preface... 7 Chapter 1 Preparing to Install Archive Services for SAP General prerequisites Software prerequisites Installation scenarios All-in-one installation Separate AS SAP Integration with EMC Centera Advanced scalability options for Tomcat server Installing required EMC Documentum software Installing EMC Documentum Administrator SAP R/3 or ECC server (UNIX or Windows) Preinstallation checklist Chapter 2 Installing Archive Services for SAP Preparing the repository Creating connections to EMC Centera Preparing the application server host Ensuring sufficient temporary disk space on the host Ensuring the Java heap size is sufficient Supported operating systems and application servers Obtaining current version software from the Documentum Download Center Installing Enterprise Integration Core DAR file Installing WebAdmin in Documentum Administrator Deploying the assap.war file Deploying assap.war using Apache Tomcat Deploying assap.war using Sun One Application Server /Sun Glass Fish Enterprise Server Deploying assap.war on BEA Weblogic Deploying assap.war on IBM WebSphere ClassLoader setting Deploying assap.war on JBoss Application Server Editing and viewing the al.properties file using JConsole Configuration for Apache Tomcat Configuration for BEA Weblogic Configuration for IBM WebSphere Editing al.properties using JConsole Significant system objects dfc.properties log4j.properties docbases.properties al.properties EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 3

4 Table of Contents Postinstallation configuration Configuring the temporary store Customizing the dfc.properties file for optimum performance EMC Documentum Archive Services for SAP, ILM extension, installation, and configuration Setup for AS SAP ILM extension WebDAV service configuration Configuring dfc.properties Configuring web.xml Copying required JAR files Copying AS SAP ILM namespace JAR file to dmwebdav Configuring the Administrative User for SAP ILM Enabling Privileged DFC on WebDAV for RPS Installing the Enterprise_Integrations_SAP_ILM.dar file Dar installation objects for AS SAP ILM extension Optional customization of AS SAP ILM extension RPS policy mapping Creating default objects for AS SAP ILM extension WebDAV customization using ConfigSAPILM tool Config.properties customization EMC Centera integration with ILM To verify details of clips stored on EMC Centera Installing PrintList Transformation Filters On-demand rendering compared with stored rendering Configuring EMC Documentum Content Server for on-demand rendering Chapter 3 Upgrading Archive Services for SAP Upgrading from AS SAP 5.3 SPx Upgrading from AS SAP 6.0, 6.0 SP Upgrading from AS SAP 6.5 SPx Chapter 4 Testing the Installation Logging in to WebAdmin through Documentum Administrator Configuring HTTP repositories for archive linking Creating an archive in WebAdmin Defining a logical ArchiveID in SAP Testing the connection between SAP and AS SAP Creating a Document Type in SAP Archiving a PrintList Viewing a Print List Chapter 5 Troubleshooting Installation Issues High levels of logging Incorrect Tomcat installation Chapter 6 Uninstalling Archive Services for SAP Preparing application servers for AS SAP uninstallation Uninstalling AS SAP using Apache Tomcat Uninstalling AS SAP using BEA Weblogic Uninstalling using IBM WebSphere EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

5 Table of Contents Appendix A Advanced Installation Option for Load Balancing Installing connectors for Apache and Tomcat Guidelines for configuring Apache and Tomcat for load balancing Appendix B Installing a DAR file using the DAR Installer GUI EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 5

6 Table of Contents List of Tables Table 1. Parameters in archives configuration page Table 2. DAR Installer fields EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

7 Preface Purpose of this guide This guide explains how to install and configure Archive Services for SAP (AS SAP) 6.5. It contains information about installation requirements, and provides task-based instructions for installing the software. Intended audience This manual is primarily intended for qualified consultants and system administrators. This role covers those who install and configure AS SAP. The AS SAP application integrates two enterprise-level software packages: the EMC Documentum content management system with the SAP R/3 or ECC system. AS SAP requires detailed knowledge of the SAP DMS and ArchiveLink interfaces. Consultants and system administrators must have experience with the software products listed in the Software Requirements section of the EMC Documentum Archive Services for SAP Release Notes. Revision history This section contains a description of this document s revision history. Revision history Revision date Description July 2008 Initial publication of document for AS SAP 6.5. December 2008 June 2009 March 2010 Update publication of document for AS SAP 6.5 Rev A02. Update publication of document for AS SAP 6.5 Rev A03. Update publication of document for AS SAP 6.5 Rev A04. Typographic conventions This guide uses the following text conventions. EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 7

8 Preface Typographic conventions used in this guide Convention Description > Represents a pop-up or pull-down menu. <Text enclosed within angle brackets> Information in this font Represents a variable name for which you must provide a value, or a defined term. Represents code samples, user input, and computer 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 argument that can be repeated more than once. Related documentation This manual forms part of a documentation suite designed to support those who install, configure, and use AS SAP. The product and documentation suite can be found on EMC Powerlink at From Powerlink, you can download the latest version of AS SAP and the related documentation suite. To access the contents in Powerlink, you will need to provide the login credentials assigned to you when you first applied for access. Note: Your login ID, by default, is your address. If you cannot locate your password, use the password finder at the bottom of the login page. AS SAP Documentation suite Title Description Target role EMC Documentum Archive Services for SAP Release Notes EMC Documentum Archive Services for SAP Installation Guide EMC Documentum Archive Services for SAP Configuration Guide Provides an overview of new and amended features, known bugs, limitations, miscellaneous technical notes, and documentation correctness and clarifications. Provides the procedures for installing Archive Services. Describes the configuration tasks that need to be performed in SAP so that SAP can communicate with Archive Services. Standard User, System Administrator, System Administrator (SAP), and Archive Services Administrator System Administrator System Administrator (SAP) 8 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

9 Preface Title Description Target role EMC Documentum Archive Services for SAP Administration Guide EMC Documentum Archive Services for SAP User Guide Describes how to configure Archive Services using the WebAdmin tool. Describes how SAP users view documents. Archive Services Administrator Standard User Note: AS SAP extensively uses the SAP ArchiveLink component. The SAP ArchiveLink documentation provides information on how you can perform advanced tasks. EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 9

10 Preface 10 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

11 Chapter 1 Preparing to Install Archive Services for SAP This chapter provides information about preparing to install AS SAP. General prerequisites The person installing AS SAP should have administrative experience with the software products listed in the EMC Documentum Archive Services for SAP Release Notes. Note: Unless the person installing the product has the prerequisite experience, EMC Documentum recommends that you do not perform installations using only EMC Documentum manuals as guidance. EMC Documentum Support can assist only with systems that were installed by qualified persons following the specific instructions outlined in both the documentation and the training manual. Software prerequisites AS SAP depends on specific versions of Documentum and third-party products, as described in the Software Requirements section of the EMC Documentum Archive Services for SAP Release Notes. Installation scenarios AS SAP may be installed in various configurations, depending on how it is mixed and matched with content addressed storage systems like EMC Centera or third-party applications like Apache and Tomcat. Different configurations may also be arrived at depending on how and where the content server and AS SAP are installed. The possible basic configurations are described in the following sections. EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 11

12 Preparing to Install Archive Services for SAP All-in-one installation You may install the repository, Application Server (for example, Tomcat), Documentum Administrator (DA), and AS SAP on one system. This installation scenario is supported on all the operating systems that are supported by AS SAP. Information on the operating systems that AS SAP supports is in the EMC Documentum Archive Services for SAP Release Notes. Separate AS SAP In this installation configuration, AS SAP need not be installed on the same system where the repository is installed. You can install Content Server and DA on one system (running any OS). On another supported Operating System, you can install JDK, a supported Web Application Server, such as Tomcat or BEA Weblogic, and AS SAP (running any OS). AS SAP may be configured to access the repository that s installed on the other machine. Integration with EMC Centera AS SAP integrates with EMC s content addressed storage system, EMC Centera. Customers using AS SAP along with EMC Centera can formulate rules that determine where information is archived, and how long it is retained. For EMC Centera connectivity, configure the Documentum server to use a CA store, as described in the EMC Documentum Content Server Administration Guide. Advanced scalability options for Tomcat server AS SAP may be installed on a Tomcat server. Tomcat can be configured to use load balancing between multiple Tomcat sessions. This configuration is particularly powerful when used in tandem with multiple Tomcat hosts. Use mod-jk as described in Installing connectors for Apache and Tomcat, page 53, as a connector for communications between Apache and Tomcat. Appendix A, Advanced Installation Option for Load Balancing contains more information on installing AS SAP on a Tomcat server in a load-balancing configuration. Installing required EMC Documentum software This section contains information about EMC Documentum software that must be installed prior to installing AS SAP. 12 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

13 Preparing to Install Archive Services for SAP Installing EMC Documentum Administrator After the database and Documentum Content Server have been installed, install Documentum Administrator as documented in the EMC Documentum Administrator Deployment Guide. After the Documentum Administrator installation is complete, install AS SAP as described in Installing Archive Services for SAP. SAP R/3 or ECC server (UNIX or Windows) Manual configuration of SAP ArchiveLink is a prerequisite for installation of AS SAP, as described in the EMC Documentum Archive Services for SAP Configuration Guide. Caution: Documentum is not responsible for problems encountered during installation due to SAP-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-related OSS Notes and patches prior to AS SAP installation. Documentum support is not responsible for answering SAP configuration questions or problems. Preinstallation checklist You must follow the information in the preinstallation checklist before you install AS SAP. If the preinstallation tasks are not done, your system will not function properly: 1. Launch SAP GUI from the intended AS SAP server or client and log in to the SAP system you want to support. If this test fails, you must resolve the connection between AS SAP and the SAP system before proceeding. 2. Be sure all previous versions of AS SAP is either physically removed or deactivated. 3. The repository should be up, running, and performing before installing AS SAP. AS SAP requires a fully functioning repository and writes configuration objects into the chosen repository during the install. 4. Create a directory on the SAP server. This directory will be used by SAP to store files temporarily until they are transported into Documentum. 5. Make sure the application server and Documentum Administrator is up and running. WebAdmin is installed after installing Documentum Administrator. Note: From 6.5 release, the administration console for both AS SAP and CS SAP is the same. Installing WebAdmin (packaged as dmei_webadmin.zip) component on DA would enable users to administer EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 13

14 Preparing to Install Archive Services for SAP both CS SAP and AS SAP. However, the CS SAP would need HVPS component in addition to what AS SAP requires for executing the DMS related activities. 14 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

15 Chapter 2 Installing Archive Services for SAP This chapter describes the installation process for AS SAP. Preparing the repository The repository should be up, running, and performing before you install AS SAP. AS SAP requires a fully functional repository so that during install, an SAP cabinet can be created and AS SAP administration objects can be written to that cabinet in the designated repository. Creating connections to EMC Centera If your installation scenario, as described in Integration with EMC Centera, includes connections to EMC Centera, you will have to create CA stores. More information on creating CA stores is in the Creating Content-Addressed Stores section of the EMC Documentum Archive Services for SAP Administration Guide. Preparing the application server host This section contains information about preparing the application server host for use with AS SAP. Ensuring sufficient temporary disk space on the host Application servers vary as to how much temporary disk space they require when an application is installed. Allow at least half a gigabyte of free disk space on the application server host for installing AS SAP: On Windows hosts, ensure that the free space is on the drive to which the TEMP environment variable points. On UNIX hosts, ensure that the free space is in $TEMP. On AIX with WebSphere, the temporary directory used by WebSphere is /tmp. EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 15

16 Installing Archive Services for SAP Ensuring the Java heap size is sufficient Setting the Java heap size properly is important to avoid out-of-memory errors: For BEA, Tomcat, and Oracle, set the heap size to 512 MB. For WebSphere, set the heap size to 1024 MB. Supported operating systems and application servers AS SAP can be installed on different combinations of operating systems and application servers. More information on supported combinations is in the Software requirements section of the EMC Documentum Archive Services for SAP Release Notes. Obtaining current version software from the Documentum Download Center To ensure that you install the current version of this product, visit the EMC Download Center at and review the product versions available for your platform. For Windows, download Archive_Services_for_SAP_6.5_Windows.zip, contains the following files: Enterprise_Integrations_Core.zip Contains the Enterprise Integrations Core DAR file and relevant script files for installing the DAR using the command line. dmei_webadmin.zip Contains the WebAdmin administration component that would be installed on DA. assap.war Contains the AS SAP application. Enterprise_Integrations_SAP_ILM.zip Contains the AS SAP ILM application, which includes the Enterprise_Integrations_SAP_ILM.dar and other related files. For Solaris, AIX, Linux, HPUX and HPUX IA64, download the respective Archive_Services_for_SAP_ 6.5_<OS>.tar, which contains the following files: Enterprise_Integrations_Core.tar dmei_webadmin.tar assap.war Enterprise_Integrations_SAP_ILM.tar Installing Enterprise Integration Core DAR file This section provides instructions for installing Enterprise_Integrations_Core.dar files on all Documentum Composer supported operating systems. Note: Use the information in this section to install other.dar files. 16 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

17 Installing Archive Services for SAP 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 is installed. 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 version of the composer can be downloaded from Powerlink. If the repository used for installing the Enterprise_Integrations_Core.dar files is not a Global repository, then the Enterprise_Integrations_Core.dar files must be installed on both the Global repository and the repository used for AS SAP. Users comfortable with the GUI mode, can make use of the Composer GUI to install DARs. The Composer GUI is specific to Windows environment. If the Content Server is running on an UNIX environment, you could still connect to the repositories from the Composer GUI installed on your Windows 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 Windows environments 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 of the 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 your machine. Set the WORKSPACE environment variable to a clean directory. For example: echo off setlocal EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 17

18 Installing Archive Services for SAP set ECLIPSE=C:\ComposerHeadless set WORKSPACE=C:\ComposerHeadless\workspace set BUILDFILE=%1 java -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 those parameters 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 <directory path of batch file and xml file>: dmant.bat DARInstallScript.xml For UNIX Change sh script mode: $ chmod a+rx dmant.sh <directory path of batch file and xml file> $./dmant.sh DARInstallScript.xml Installing WebAdmin in Documentum Administrator To complete the 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 a temporary directory. 3. Copy the dmeiwebadmin folder into the Documentum Administrator (DA) folder created during the Documentum Administrator installation. 4. Copy the WEB-INF folder into the DA folder, selecting yes when prompted to overwrite all the contents of the existing WEB-INF folder. 5. Copy the theme folder inside the custom folder into the DA\custom folder, selecting yes when prompted 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. WebAdmin is ready for use. The EMC Documentum Archive Services for SAP Administration Guide has additional information about using WebAdmin to administer your system. 18 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

19 Installing Archive Services for SAP Deploying the assap.war file The following procedure describes how to prepare the assap.war file for installation. To prepare the assap.war file for installation: 1. Rename assap.war.zip to assap.war. 2. Create a directory named assap. 3. Copy the assap.war file to the assap directory created in step Unjar the file using the following jar command: jar xvf assap.war The war file is extracted to a directory called assap. 5. Edit dfc.properties file in the assap/web-inf/classes folder as follows: a. Type the docbroker host name. For example: dfc.docbroker.host[0]= b. Type the docbroker port number. For example: dfc.docbroker.port[0]=1489 optional, default 1489 c. Optionally, type the DFC data directory. For example: dfc.data.dir=c:/documentum d. Type the DFC global BOF registry docbase name. For example: dfc.bof.registry.repository= cssap53_dev_assap e. Type the DFC global BOF registry docbase user name. For example: dfc.bof.registry.username=dm_bof_registry f. Type the DFC global BOF registry docbase user-encrypted password. For example: dfc.bof.registry.password=kbb9dmxb6pq\= 6. Based on the operating system being used, edit the log4j.properties to have the correct path for the log file. 7. Re-create the assap.war from the temporary folder using the jar -cvf command. 8. Deploy the AS SAP war file using the application server procedure appropriate for your installation. Deploying assap.war using Apache Tomcat To deploy using Apache Tomcat: 1. Ensure Apache Tomcat is configured to deploy the assap.war file in unpacked mode. This is the Apache Tomcat default setting. 2. Copy the rejarred assap.war file to the <<Tomcat>>/webapps folder. 3. Restart the Apache Tomcat server. EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 19

20 Installing Archive Services for SAP Deploying assap.war using Sun One Application Server /Sun Glass Fish Enterprise Server To deploy using Sun One Application Server/Sun Glass Fish Enterprise Server: 1. Connect to application server admin page. For example, 2. Type the Username/Password. 3. Click the Web Application link. 4. Click the Deploy button to deploy the assap war file by typing the path of the assap war file. 5. Click Next and give assap as the Application name and context Root, and click Finish. 6. Add the following permission to the server policy present in the location: SUN_APP_SERVER_DOMAINS_HOME/domains/domain1/server1/config/server.policy grant { permission java.util.propertypermission "*", "read,write"; permission java.io.filepermission "${documentum}/-", "read, write, delete"; permission java.io.filepermission "${user.home}/-", "read, write, delete"; permission java.io.filepermission "/tmp/-", "read, write, delete"; permission java.io.filepermission "${java.io.tmpdir}/-", "read, write, delete"; permission java.io.filepermission "$S(INSTANCE_CONFIG_DIRECTORY)/-", "read, write, delete"; permission java.lang.runtimepermission "createclassloader"; permission java.net.socketpermission "*", "connect,accept"; Permission java.lang.runtimepermission "getprotectiondomain"; permission java.lang.runtimepermission "shutdownhooks"; permission java.lang.reflect.reflectpermission "*"; permission java.security.allpermission; }; 7. Restart the application server. 20 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

21 Installing Archive Services for SAP Deploying assap.war on BEA Weblogic Follow the steps 1 through 4 in Deploying the assap.war file and copy all the files to a folder, such as assap. To deploy on BEA Weblogic: 1. Unjar assap.war into a directory named assap, as follows: jar -xvf assap.war Note: The directory name is case-sensitive. Ensure the node manager of the BEA Weblogic domain is active. 2. Start the BEA Weblogic server: 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 assap directory you created in step 1. Specifiying the assap directory installs all components in and below the directory. For example: /export/home0/bea02/softwares 8. Select the assap directory and click Next. 9. Specify whether to target the installation as application. 10. Click Next. 11. Select the servers and clusters, or both, to which you want to deploy AS SAP. 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 and clusters. 14. Click Next. 15. Review the configuration settings you specified: app-root /app /plan EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 21

22 Installing Archive Services for SAP Note: If you install an application that follows this directory structure and there is no deployment plan 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 set additional configuration settings for the Web application. If you chose to change this information later, the Administration Console returns you to the Deployments table, which should now include 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 assap.war on IBM WebSphere To deploy on IBM WebSphere: 1. Start the IBM WebSphere server. For example: 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 file system with context root as assap. 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 assap as the Application Name. Click Next. 9. In the Map modules to servers screen, select the assap.war file for the module and click Next. 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 Java sources. Valid values are 13, 14, and 15. The default value is 13, which specifies source level 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 click Next. For WebSphere Application Server Version 7.0, change the context root of application to /assap. 14. Click Finish. The following message indicates a successful installation. ADMA5013I: Application assap installed successfully 22 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

23 Installing Archive Services for SAP ClassLoader setting To complete the installation: 1. Browse to Application > Enterprise Applications and click assap. 2. Click Manage Modules under the Modules heading. 3. In the following screen, click the assap hyperlink. 4. In the Class loader order list box, select Class loaded with application class loader first and click OK. 5. In the next screen, click Save. 6. In the Manage Modules screen, assap appears selected in red. 7. Log out and restart the server to deploy AS SAP. Deploying assap.war on JBoss Application Server To deploy on JBoss: 1. Unjar the rejarred assap.war file using the following command: jar -xvf assap.war The war file is extracted to a directory called assap. 2. Rename the assap directory to assap.war. 3. Copy the assap.war folder to <<JBOSS_HOME>>\server\default\deploy folder. 4. Restart the application server. Editing and viewing the al.properties file using JConsole This section describes procedures used for viewing and editing the al.properties file in the JConsole editor without the need for restarting the application server as follows: Configuration for Apache Tomcat Configuration for BEA Weblogic Configuration for IBM WebSphere Editing properties using JConsole Configuration for Apache Tomcat To enable the JMX agent for Apache Tomcat for a Windows environment, add EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 23

24 Installing Archive Services for SAP the following line in the <TOMCAT Home DIR>\bin\catalina.bat file: set JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false To enable the JMX agent for Apache Tomcat for a Solaris environment, add the following line in the <TOMCAT Home DIR>\bin\catalina.sh file: set JAVA_OPTS=$JAVA_OPTS -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false Configuration for BEA Weblogic To enable the JMX agent for BEA Weblogic, using the Documentum Administrator Console, add the following line into the field of Arguments under Servers > <Application Server Name> > Server Start: -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote. authenticate=false -Dcom.sun.management.jmxremote.ssl=false Configuration for IBM WebSphere To enable the JMX agent for IBM WebSphere 6.1: 1. Using the Documentum Administrator console, add the following line into Application servers><application Server Name> > Process Definition > Java Virtual Machine > Generic JVM Argument: -Djavax.management.builder.initial= -Dcom.sun.management.jmxremote 2. Add, or un-comment, the following lines in the <Your WebSphere JRE>/lib/management/ management.properties file: com.sun.management.jmxremote.port=9999 com.sun.management.jmxremote.authenticate=false com.sun.management.jmxremote.ssl=false Editing al.properties using JConsole To edit the al.properties file using JConsole: 1. Open a command prompt at: <JAVA_HOME>/bin 2. Type JConsole The JConsole editor displays. 3. In the remote tab, type the <Host Name> and the JMX port number. Use 9999 for the JMX port number. 24 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

25 Installing Archive Services for SAP 4. Click Connect. 5. In the com.documentum.ei.al.jmx.mbeans section, navigate to the Mbeans tab and click AlProperties. 6. Edit the desired properties and press Enter. Significant system objects This section contains information about significant system objects installed during AS SAP war file deployment. dfc.properties Documentum stores data in the dfc.properties file located in the <Tomcat_installation_ directory>\webapps\<archive_services_virtual_directory>\web-inf\classes directory. More information is in the EMC Documentum Documentum Foundation Classes Installation Guide. log4j.properties All logging details are available in thelog4j.properties file available in the following directory: <Tomcat-Installation-Directory>\webapps\ <Archive Services Virtual Directory>\WEB-INF By default, the log output goes to the alserver.log file available in the following directory: <Tomcat-Installation-Directory>\webapps\ <Archive Services Virtual Directory>\WEB-INF/logs Log4j.properties can be changed during runtime of servlet, and updates are detected automatically. docbases.properties This file contains the repository login configuration details such as the server ID, username, and password. If you intend to edit this file, we recommend that you use WebAdmin for this purpose. More information is in the Configuring, Viewing, and Editing Repository Connections section of the EMC Documentum Archive Services for SAP Administration Guide. al.properties The system parameters for the AS SAP servlet are defined in al.properties. al.properties is located in the following directory: <Tomcat-Installation-Directory>\webapps\<Archive Services-Virtual-Directory>\WEB-INF EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 25

26 Installing Archive Services for SAP Postinstallation configuration This section contains AS SAP postinstallation configuration information. Configuring the temporary store The al.properties file is located in <Tomcat-Installation-Directory>\webapps\<Virtual- Directory>\WEB-INF. You must configure the al.properties file so that it points to a valid directory in the file system with complete access rights; AS SAP writes data to file in this temporary store before reading or writing to HTTP request. For example, you could customize the relevant section of the al.properties file as follows: archiving.tempdir=c:\\archivelink Note: If you are running AS SAP on UNIX, you will need to customize the file differently. In UNIX, you could customize the relevant section as follows: archiving.tempdir=/usr/temp/al_server_data Customizing the dfc.properties file for optimum performance Certain parameters must be customized in the dfc.properties file in order to optimize Documentum Client Library s (DMCL s) behavior; this is necessary to obtain optimum performance from AS SAP. To customize parameters in dfc.properties: 1. Select Start > Run. 2. In the Open field, type dfc.properties. The dfc.properties file opens. Note: In UNIX, the dfc.properties file is usually available in $DOCUMENTUM. 3. Add the following attribute to dfc.properties: dfc.session.max_count = 10 This attribute determines the maximum number of sessions. Note: The value for this attribute is determined by the following formula: dfc.session.max_count [docbases.numberofconnections (default: 9) * numberofdocbases] + 1. In this formula, the following attributes occur in the al.properties file, as described in Configuring the temporary store, page 26: docbases.numberofconnections 26 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

27 Installing Archive Services for SAP This attribute determines the number of connections established by the repository. The default value is 9. numberofdocbases This attribute indicates the number of repositories that have been installed. If you have installed one repository, this value will be 1. After installing the first repository, you must set the value of dfc.session.max_count as 10 because, per the formula, dfc.session.max_count [docbases.numberofconnections (default: 9) * numberofdocbases (1)] + 1. If you have three repositories installed, and the value of docbases.numberofconnections is 5, then dfc.session.max_count should be Set the values of the following attributes as indicated below: dfc.session.max_count dfc.data.local_dir = ${dfc.data.user_dir}/local dfc.data.local_diskfull_limit = 0 dfc.data.local_purge_on_diskfull = true Note: Customizing these attributes is not mandatory for AS SAP to function correctly: dfc.data.local_diskfull_limit dfc.data.local_purge_on_diskfull These customized attributes improve the performance of AS SAP, although AS SAP functions even if these attributes are not set. It is mandatory to add dfc.session.max_count to dfc.properties. EMC Documentum Archive Services for SAP, ILM extension, installation, and configuration Unzip the Enterprise_Integrations_SAP_ILM.zip (Enterprise_Integrations_SAP_ILM.tar for UNIX) to a local directory. The following are the files contained in the directory: Enterprise_Integrations_SAP_ILM.dar and the related dar installer scripts ConfigSAPILM.jar dmwebdav.jar Namespace.jar Note: Do not install the AS SAP ILM extension if you do not specifically plan to use the AS SAP ILM extension. Setup for AS SAP ILM extension To set up your AS SAP ILM extension installation solution, ensure the following steps are completed: 1. Retention Policy Services Licensing is enabled during installation of the content server. EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 27

28 Installing Archive Services for SAP Note: If the content server is already installed, log in to Documentum Administration with administrator rights and adjust your licensing setting using the licensing link on the main administration page. 2. Install RPS and PRM dar files on the repository in the same order (RPS installation guide provides more details). 3. Install dmwebdav.war on a web server. 4. Install rpsa.war and da.war (if it is not already installed) preferably on a different web server than the dmwebdav. 5. dmwebdav service configuration: Edit the dfc.properties to connect to the configured repository. Edit the web.xml file of dmwebdav with information on the repository to be used for ILM-based archiving. Copy the necessary RPS library files to dmwebdav/web-inf/lib directory. Copy SAP ILM namespace JAR file to dmwebdav/web-inf/lib directory. Note: The application server needs to be restarted if you make changes to the dfc.properties or the web.xml file or if you copy jar files to webdav s lib folder. 6. Install Enterprise_Integrations_Core.dar (if it is not already installed) on the repository. 7. Install the Enterprise_Integrations_ILM.dar. 8. Enable Privileged DFC on WebDAV for RPS using the Privileged Clients utility in DA. 9. Create default objects for AS SAP ILM extension execute ConfigSAPILM tool. 10. Config.properties customization: Edit config.properties specifying details of the install owner and EMC Centera attributes in case EMC Centera is being used for archiving. 11. If using EMC Centera, create EMC Centera store with retention attribute information. EMC Centera integration with ILM provides more details. The AS SAP ILM extension solution is ready to run. WebDAV service configuration WebDAV is distributed as a WAR file containing all the application files. The EMC Documentum WebDAV Installation Guide has complete information about the WebDAV installation procedure. These two application files must be edited for ILM configuration: dfc.properties web.xml Configuring dfc.properties Set field dfc.docbroker.host[0] to the name of your docbroker machine. 28 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

29 Installing Archive Services for SAP Configuring web.xml Set these web.xml parameter values as follows. Parameter name docbase auth-type documentobjecttype_docbasename folderobjecttype_docbasename return200forcollection extensions-enabled Value docbase name (your docbase) BASIC (default) sap_ilm_document sap_ilm_folder yes true Note: The parameter names documentobjecttype_docbasename and folderobjecttype_ docbasename should be changed to documentobjecttype_<your docbase name> and folderobjecttype_<your docbase name> respectively. The following is an example excerpt of a web.xml file for a repository named dctmsapilm: <init-param> <param-name>docbase</param-name> <param-value>dctmsapilm</param-value> <description> Name of the Docbase to be made accessible through Documentum WebDAV Services </description> </init-param> <init-param> <param-name>documentobjecttype_ dctmsapilm</param-name> <param-value>sap_ilm_document</param-value> <description> The docbase object type that will be used while creating new objects. </description> </init-param> <init-param> <param-name>folderobjecttype_ dctmsapilm</param-name> <param-value>sap_ilm_folder</param-value> <description> The docbase object type that will be used while creating new objects. </description> </init-param> <init-param> <param-name>return200forcollection</param-name> <param-value>yes</param-value> <description> This is to enable new certification for SAP Client,this returns 200 instead of 403 for collection objects for a HEAD/GET method. </description> </init-param> EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 29

30 Installing Archive Services for SAP Copying required JAR files Copy these JAR files from the WEB-INF\lib directory of a Retention Policy Services Administrator (RPSA) installation to the WEB-INF\lib directory of the dmwebdav installation: DmcPolicyEngine.jar DmcRecords.jar DmcRps.jar IDmcPolicyEngine.jar IDmcRps.jar IDmcRpsModules.jar Copying AS SAP ILM namespace JAR file to dmwebdav Copy the namespace.jar and dmwebdav.jar present in the AS SAP installer to dmwebdav/web-inf/lib Directory. Configuring the Administrative User for SAP ILM AS SAP ILM administrator user should be a member of dmc_rps_retention_manager group, which is created by RPS installation. For RPS versions below 6.5 SP1, administrative user should be a member of dm_retention_managers group. To configure the administrative user for SAP ILM: 1. Connect to WebAdmin, as described in Logging in to WebAdmin through Documentum Administrator. 2. Click to expand the System subnode and select the DocLink subnode. The SAPILM screen appears. 3. Edit the config.properties file, as follows: SAPILM.admin.username = <admin user name> Name of the administrative user. SAPILM.admin.password Password of the administrative user. 4. Click OK to save the new administrative user for SAP ILM configuration. Enabling Privileged DFC on WebDAV for RPS DFC client instance for dmwebdav and DFC client instance used for executing configsapilm, should be privileged, to complete any ILM actions. Global repository name should be the same for both DFC instances. In order to achieve this, as mentioned below, first open dmwebdav url, so that DFC instance is registered in the global repository. Then enable privileged client for dmwebdav DFC 30 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

31 Installing Archive Services for SAP instance from Documentum Administrator (DA). RPS version 6.5 is required for SAP ILM, which uses Privileged DFC to dynamically grant users permissions in the repository. Note: You can use the same dfc instance of dmwebdav for executing configsapilm tool, so that previleged dfc client is reused. Configure Privileged DFC for specific instances of dfc.jar when multiple dfc.jar files are present following these guidelines: 1. After installing WebDAV, connect to WebDAV by using Microsoft Internet Explorer and selecting File > Open. 2. Type your WebDAV URL ( and select Open as Web Folder. The file dfc.keystore is created in the same directory as your dfc.properties file. 3. Open dfc.keystore in a text editor and search on dfc. A string beginning with dfc_ followed by 28 alphanumeric characters, used as the ClientID by DA, is found; for example, dfc_hiqlx2kxxqshgkigcu7td6nx3nka. 4. Start DA, navigate to the Privileged Clients node, and select File > Manage Clients. A list of clients and dfc.jar files connected to the content server appears. 5. Locate the ClientID retrieved from your dfc.keystore file, move it the right, and click OK. 6. Right-click the new entry from the list and select Approve Privilege. Privileged DFC is now enabled. Installing the Enterprise_Integrations_SAP_ILM.dar file Use the information in Installing a DAR file section to first install the Enterprise_Integrations_Core.dar file, and then as guidance for installing the Enterprise_Integrations_SAP_ILM.dar file. Dar installation objects for AS SAP ILM extension The dar file installs these objects: config.properties in /System/Doclink/SAPILM dm_type sap_ilm_document. This object derives from dm_document. The attributes for this object are: al_object_type: string(10) al_obj_id: string(50) al_crep_id: string(2) al_doc_type: string(10) al_store_date: dm_time al_doc_class: string(20) EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 31

32 Installing Archive Services for SAP al_mime_type: string(128) al_table: string(5) dm_type sap_ilm_folder. This object derives from dm_folder with the attribute origin: string(16). BOF module. The module implements the WebDAV namespace extension interface. Optional customization of AS SAP ILM extension RPS policy mapping The only optional configuration parameter for the AS SAP ILM extension is provided for users who already use RPS, and enables consistent retention policies across the docbase. Adjust the /System/Doclink/SAPILM/config.properties file located in the docbase as listed in the following table. Note: Adjusting the config.properties file in the docbase is optional, and only required when using RPS policies other than the default policies available with AS SAP ILM extension. Parameter NAME.path=/path/in/docbase NAME.policy=rpsPolicy Value Substitute NAME with SAPILM. Substitute NAME with SAPILM. Policy Options Note: Any number of policies can be mapped to a directory. Option Retention Strategy Disposition Strategy Immutability Rule Rendition Rule Virtual Document Retention Rule Snapshot Retention Rule Extended Immutability Rule Extended Rendition Rule Substitute rpspolicy with the name of an existing policy that conforms to the Policy Options guidelines below. Note: The first configuration creates RPS 1 Phase + Final policies. There are many options that must be selected for the overall policy on the info tab. Value Linked Destroy All Do not change All Renditions Retain Root and Children Retain Root and Children Do not change All Renditions The AS SAP ILM extension reads the config.properties file for custom policies. When the BOF module gets a request to apply a retention policy, it will first read this file and see if the path specified 32 EMC Documentum Archive Services for SAP Version 6.5 Installation Guide

33 Installing Archive Services for SAP in the PropPatch request is configured for special behavior. If the path is configured, the specified policy is applied. Creating default objects for AS SAP ILM extension WebDAV customization using ConfigSAPILM tool The Java configuration application is a CLI command that must be run to enable SAP ILM WebDav. Note: Be sure to enable the DFC instance used to execute configsapilm tool as a privileged client from inside the Documentum Administrator. To create the RPS policies, use the command: PATH_TO_WEB_INF/lib/dfc.jar;PATH_TO_WEB_INF\classes; PATH_TO_CONFIGJAR\ ConfigSAPILM.jar;PATH_TO_WEB_INF/lib/ IDmcPolicyEngine.jar;PATH_TO_WEB_INF/lib \IDmcRps.jar;PATH_TO_WEB_INF/lib\IDmcRpsModules.jar;PATH_TO_WEB_INF/lib \DmcPolicyEngine.jar;PATH_TO_WEB_INF/lib\DmcRecords.jar;PATH_TO_WEB_INF/lib \DmcRps.jar" com.documentum.ei.tools.configsapilm docbaseuser password docbase [domain] where: PATH_TO_CONFIGJAR is the full path of the directory containing the file ConfigSAPILM.jar PATH_TO_WEBAPP_LIB is the full path to the WEBINF directory of the WebDAV web application. For e.g. PATH_TO_WEBAPP_LIB =C:/tomcat/webapps/dmwebdav/WEB-INF The user specified must be configured as an RPS Retention Manager (dm_group: dmc_rps_retentionmanager) and have enough privileges to create a user. The configuration performs the following actions: Creates a dm_user object sap_ilm_user: Initial password is set to 1Lmus3r Creates a dm_group object sap_ilm_group. Adds sap_ilm_user to the dm_group s dmc_rps_retentionmanager, and sap_ilm_group. Creates an RPS Contact object that maps to the sap_ilm_group object. Creates an RPS Authority object that maps to the created Contact. Creates two RPS Condition Objects. The Authority is set to the created Authority object: StartDate in the category SAPILM FulfillDate in the category SAPILM RPS policy named SAPILM0YEARS is created. If you see any errors during execution of the configsapilm tool, navigate to privileged clients and ensure that the DFC instance is registered as privileged. It is important to observe the configsapilm tool execution complete without errors. EMC Documentum Archive Services for SAP Version 6.5 Installation Guide 33