EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com
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.
Table of Contents Preface... 5 Chapter Installing RM and RPS Web Services... 7 EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide 3
Table of Contents 4 EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide
Preface This guide describes how to install EMC Documentum Web Services for Records Manager (RM) and Retention Policy Services (RPS). Intended audience This manual is intended for administrators or programmers who need to deploy RM and RPS web services. Revision history The following changes have been made to this document. Revision Date April 2010 Description Initial publication. EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide 5
Preface 6 EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide
Installing RM and RPS Web Services This chapter serves as an addendum to the EMC Documentum Foundation Services (DFS) version 6.5 Deployment Guide which provides general deployment instructions of web services to various application servers. Use the DFS 6.5 Deployment Guide along with the instructions contained in this chapter. Deploy DFS separately, as the RM/RPS Web Services does not provide access to DFS core services. Download RM/RPS files Deploy the RM/RPS EAR or WAR file Update dfc.properties RM/RPS property configuration Register DFC client for the application Dependency on RM/RPS Application and Documentum Archive(DAR) Some useful reference document includes: EMC Documentum Foundation Services 6.5 Deployment Guide EMC Documentum Foundation Services 6.5 Development Guide 1. Download the required zip file(s): rm-webservices-6.5.zip rps-webservices-6.5.zip (for RPS Web Services) Each zip file contains: an Enterprise Archive (EAR) file a Web Archive (WAR) file Client libraries (for Java and.net) JavaDoc for Client libraries WSDL for the web services Service model xml file to publish the web services RM/RPS property configuration file RM Web Services is a subset of RPS Web Services which consists of the following web services: Policy Service Retention Markup Service EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide 7
Installing RM and RPS Web Services Federated Proxy Service Physical Records Library Service In addition, the RM Web Services include the "Formal Record Service". 2. Deploy the RM/RPS EAR or WAR file. Refer to the DFS 6.5 Deployment Guide for specific deployment instructions to the respective application server. 3. Update the dfc.properties file. Modify dfc.properties so it is configured with the correct values for the docbroker name and the global registry docbase name. On Tomcat for example, update the dfc.properties file in ${tomcat.home}/webapps/rpsa/web-inf/classes and uncomment each line: #dfc.docbroker.host[0]= and set to your docbroker. The best method to perform this and avoid mistakes, is to copy the four lines, as listed in the example below, from the generated dfc.properties file on the Content Server under C:\Documentum\config. dfc.docbroker.host[0]=<my Server> dfc.globalregistry.repository=<my Repository> dfc.globalregistry.username=dm_bof_registry dfc.globalregistry.password=<my Password> Also, note: Each web application has its own copy under WEB-INF\classes. Each enterprise application has its own copy under APP-INF\classes. Edit the file correctly and specify the docbroker host. Ensure to uncomment the lines (remove #). The global registry repository name is case sensitive. The Global registry password needs to be in encrypted form. Here is an example: dfc.docbroker.host[0]=mydocbroker dfc.globalregistry.password=avhss63+9xy\= dfc.globalregistry.repository=globalrepo_lab02 dfc.globalregistry.username=dm_bof_registry 4. Set RM/RPS property configuration. In order to overwrite the default DFS property configuration settings, use the Java Virtual Machine parameter (using the -D option) named "dfs-runtime.properties.file" to set to the location of the RM or RPS property configuration file respectively. For example, if you deployed RM web services, you can specify the Java option as follows: -Ddfs.runtime.properties.file=C:\RM\config\rm-custom-runtime.properties And, if you deployed RPS web services, you can specify the Java option as follows: -Ddfs.runtime.properties.file=C:\RPS\config\rps-custom-runtime.properties Note: 1. By default, DFS configuration settings are set in "dfs-runtime.properties" which is packaged in "emc-dfs-rt.jar" within DFS EAR file, "emc-dfs.ear". 2. The RM configuration settings are set in "rm-custom-runtime.properties". The RPS configuration settings are set in "rps-custom-runtime.properties". You will need to restart the application server instance after any change to the configuration file. 8 EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide
Installing RM and RPS Web Services For a detailed description on the DFS property configuration, refer to the DFS 6.5 Deployment Guide. 5. Register the DFC client for the application. Register the DFC client (jar file) using Documentum Administrator (DA) on all RM/RPS repositories only after the application server has been restarted. Login to DA and choose the RM/RPS enabled repository. You will need to approve the privileged DFC client on each RM/RPS repository to complete the registration. a. Using DA, navigate to Administration > Privileged Clients and select File >Managed Clients. b. Select the client instances required and move it to the right column. Click OK to confirm selection. c. Right-click the applicable client listed according to the Client Name in the content pane and click Approve Privilege. For a detailed description of privileged DFC, refer to Content Server Fundamentals. For instructions on using Documentum Administrator, refer to the online help or to the Documentum Administrator User Guide. 6. Dependencies on RM/RPS Application and Documentum Archive (DAR). The RM and the RPS Web Services have dependencies on the business logic in the Records Manager (RM) and Retention Policy Services (RPS) BOF modules. Therefore, the RM and RPS Documentum Archive (DAR) files are required to be deployed to the repository prior to using this service. In addition the RM and RPS configuration objects must be created using the Records Manager Administrator (RMA) or Retention Policy Services Administrator (RPSA) user interfaces respectively before running the web services. As well, a global repository is mandatory to support privileged DFC since RM and RPS BOF modules access privileged code. The DFC client for the web service will need to be registered using Documentum Administrator (DA) on all the RM and RPS repositories only (not the global repository). Therefore, only Content Server version 6 or higher is supported. 7. Restart RM/RPS Web Service instances. Restart the application instance for the RM/RPS Web Services in order for changes to take affect. 8. Test the RM/RPS Web Services deployment. To verify that the deployment of the web services was successful, verify that the services can be access using a browser. For example, verify if the Policy Service is accessible at the following URL: http://<hostname>:<port>/services/policy/policyservice?wsdl The Policy Service definition should be visible in the browser. Note: In the case of the Apache Tomcat application Server, the URL should include the web application name, such as "context". For example, in the case of the RM web service use: http://<hostname>:<port>/emc-rm/services/policy/policyservice?wsdl EMC Documentum Web Services for Records Manager and Retention Policy Services Version 6.5 SP3 Deployment Guide 9