WebDav Documentum 6.5

EMC® Documentum®

WebDAV ServicesVersion 6.5

Deployment and Configuration GuideP/N 300006949 A01

EMC CorporationCorporate Headquarters:

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

Copyright © 2001 ‑ 2008 EMC Corporation. All rights reserved.

Published July 2008

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 REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up‑to‑date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

Table of Contents

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

Chapter 1 WebDAV Services Overview ................................................................... 9What is WebDAV? ....................................................................................... 9What is WebDAV Services? ......................................................................... 10HowWebDAV Services works..................................................................... 10Terminology........................................................................................... 11Communication sequence ....................................................................... 12Methods ................................................................................................ 13Locks ..................................................................................................... 15Lock cleanups .................................................................................... 16

Mac resource forks ................................................................................. 16Macintosh type and creator codes ............................................................ 17Preserving resource forks with MacBinary ............................................... 18

Chapter 2 Preparing for Deployment ..................................................................... 21Predeployment requirements for Windows .................................................. 21Software requirements ............................................................................ 21Predeployment checklist ......................................................................... 22Notes about the DFC .............................................................................. 23

Predeployment requirements for Unix ......................................................... 24Software requirements ............................................................................ 24Permissions............................................................................................ 25Setting environment variables ................................................................. 25Predeployment checklist ......................................................................... 27Notes about the DFC .............................................................................. 28

Chapter 3 Deploying WebDAV Services ................................................................. 31Download and unpack the WAR file ............................................................ 31Enabling DFC connections to repositories .................................................... 32Configuring the web.xml file ....................................................................... 34Configuring log file locations ...................................................................... 35Deploying the WAR file .............................................................................. 35Installing the WebDAV DAR file.................................................................. 36Installing the WebDAV source for Content Server ......................................... 39

Chapter 4 Completing the Deployment .................................................................. 41Configuring the config.xml file .................................................................... 41Applying the MS update for Vista................................................................ 41Starting and stopping the application server on Windows ............................. 42Controlling the Windows/Apache Tomcat application server..................... 42Controlling the Windows/BEAWebLogic application server ..................... 42Controlling the Windows/IBMWebSphere application server.................... 43

EMC Documentum WebDAV Services Version 6.5 Deployment and Configuration Guide 3

Table of Contents

Starting and stopping the application server on UNIX................................... 43Controlling the UNIX/Apache Tomcat application server .......................... 43Controlling the UNIX/BEAWebLogic application server ........................... 44Controlling the UNIX/IBMWebSphere application server ......................... 44

Verifying the deployment............................................................................ 44

Chapter 5 Removing WebDAV Services ................................................................. 45Removing WebDAV Services on Windows ................................................... 45Removing WebDAV Services on UNIX......................................................... 45

Chapter 6 Setting Up WebDAV Services Clients .................................................... 47Configuring WebDAV clients ...................................................................... 47The WebDAV Services URL..................................................................... 48

Configuring a Windows Web Folder for WebDAV Services ........................... 48Configuring a Macintosh Web Folder for WebDAV Services .......................... 50

Chapter 7 WebDAV Services Configuration ........................................................... 53Configuring the servlet ............................................................................... 53Activating logging ...................................................................................... 54Accessing other repositories ........................................................................ 55Creating configurable object types on import................................................ 55Configuring for SAP XML client integration ................................................. 57

Chapter 8 WebDAV Services Administrator ........................................................... 59Using the WebDAV Services Administrator.................................................. 59Logging in ................................................................................................. 60Listing allocated WebDAV sessions.............................................................. 61Viewing repository attributes ...................................................................... 62Cleaning up WebDAV orphan locks ............................................................. 63Listing scheduled Lock Cleanup jobs ........................................................... 64Displaying WebDAV Server configuration.................................................... 64Changing the Administrator password ........................................................ 66Logging out ............................................................................................... 67

Chapter 9 Troubleshooting .................................................................................... 69Cannot connect to WebDAV Services ........................................................... 69Authentication never occurs ........................................................................ 70Error creating temp file exception occurs (Tomcat)........................................ 70Running out of sessions .............................................................................. 71Cannot copy or paste cabinets ..................................................................... 71Errors related to incorrect port numbers....................................................... 72

Appendix A Sample servlet web.xml file ................................................................... 73

4 EMC Documentum WebDAV Services Version 6.5 Deployment and Configuration Guide

Table of Contents

List of Figures

Figure 1. WebDAV Services deployment on a separate host............................................. 11Figure 2. WebDAV Services deployment on the Content Server host ................................ 11


Table of Contents

List of Tables

Table 1. WebDAV methods and semantics .................................................................... 13Table 2. Predeployment checklist for Windows ............................................................. 22Table 3. Required environment variables ...................................................................... 25Table 4. Predeployment checklist for UNIX .................................................................. 27


Preface

This manual contains information and instructions needed to deploy and configure WebDAV Serviceson a Windows or UNIX host. It explains the WebDAV protocol, outlines deployment scenarios, anddescribes how WebDAV Services works and interacts with other client applications. In addition,this manual outlines requirements that must be met before deployment, and provides step‑by‑stepinstructions for deploying, configuring, administering, and removing Documentum WebDAVServices.

To ensure that you deploy the current version of this product and that you have the correctdocumentation, including the latest version of this document, visit the Download Center(https://EMC.subscribenet.com/control/dctm/index) and review the product versions available foryour platform. For technical support, visit the Powerlink site (http://powerlink.EMC.com).

Intended audienceThis manual is primarily intended for the person responsible for deploying, configuring,administering, and/or removing Documentum WebDAV Services.

Readers should be familiar with Windows or UNIX operating systems, depending onyour configuration.

Revision historyThe following changes have been made to this document.


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

http://powerlink.emc.com

Preface

Revision history

Revision date Description

July 2008 Initial release


Chapter 1WebDAV Services Overview

This chapter provides an overview of WebDAV Services. It includes the following sections:• What is WebDAV?, page 9• What is WebDAV Services?, page 10• How WebDAV Services works, page 10

What is WebDAV?WebDAV (Web‑based Distributed Authoring and Versioning) is based on HTTP(HyperText Transfer Protocol) — the standard protocol for viewing and browsingresources on an HTTP Server. WebDAV is a set of extensions to the HTTP that alsoallows users to cooperatively edit and manage files on remote web servers. Users canadd, version, delete, or change directories and documents and their properties. TheWebDAV protocol uses all the request and response headers and methods specified bythe HTTP, plus some additional request and response headers and methods to facilitateauthoring and versioning of resources.

Many major software vendors are adopting the WebDAV standard and allowingintegration to their toolsets via WebDAV. As such, an increasing number of applications(for example, Microsoft Word and PowerPoint) are capable of providing authoringand versioning capabilities for content residing on a remote machine using WebDAVas the protocol. These WebDAV‑enabled applications can communicate with anyWebDAV‑compliant server, such as WebDAV Services, to provide a set of basic contentmanagement functionality, including browsing a content repository, viewing and editingdocuments, and viewing and updating document properties.


WebDAV Services Overview

What is WebDAV Services?WebDAV Services is an extension of Documentum’s Content Server that allowsWebDAV‑enabled clients to author and version documents contained within a repository.

Traditionally, the only way to interact with a repository was to use a Documentum client(such as Documentum Desktop). Now, if the advanced features of the Documentumclient are not required, WebDAV Services allows WebDAV‑enabled clients running onMicrosoft Windows or Apple Macintosh platforms to view the Documentum repositoryas a hierarchical file system, and allows users to author and version objects in therepository without the need to deploy a Documentum client.

Essentially, WebDAV Services acts as an interface to the repository. The client simplysends messages that conform with the WebDAV protocol to WebDAV Services, andWebDAV Services handles all interactions with the repository.

Through WebDAV Services, Documentum can provide tight integration with creativeand editing applications, enabling Macintosh andWindows users to access the repositorydirectly from the tools in which they work. It allows for easy import and export ofcontent, regardless of platform. Users can save their files directly to the repository,retrieve them from the repository, check them out of the repository, and check them in,along with the appropriate object properties.

How WebDAV Services worksThe WebDAV Services product consists of a WebDAV server (implemented as a Javaservlet), an administrative client (WebDAV Services Administrator), and a set ofsupporting utilities that are deployed on the Content Server. Together these componentsprovide a basic set of repository functionality to application users without requiringclient‑side development or integration.

WebDAV Services can be deployed on the same host as Content Server or on a separatehost (although a separate host is recommended). In both cases, WebDAV Services mustbe deployed alongside the correct version of Documentum Foundation Classes (DFC).If you deploy WebDAV Services on the same machine as Content Server, which mayalready have DFC, you must still deploy the correct version of DFC packaged with theWebDAV Services deployment files. For more information see Notes about the DFC,page 23 for Windows, or Notes about the DFC, page 28 for UNIX.

The following diagrams illustrate possible WebDAV Services deployment scenarios.



Figure 1. WebDAV Services deployment on a separate host

Figure 2. WebDAV Services deployment on the Content Server host

Terminology

This section defines WebDAV‑specific terminology used throughout this manual indescribing WebDAV Services. If you are new to WebDAV, you should familiarizeyourself with these terms:



Request method — A method that can be issued in the HTTP request, based onHTTP specifications; for example, GET, POST, PUT, DELETE, and so on. The WebDAVprotocol adds various request methods to the HTTP, such as LOCK, UNLOCK, COPY,MOVE, and so on.

WebDAV request — A request to perform an action on a WebDAV resource. AWebDAV request consists of a request method, a URI (Universal Resource Identifier),additional headers, and optionally some content. The valid values for the requestmethod and the headers are defined by the WebDAV specification.

WebDAV response — A response after processing a WebDAV request. A WebDAVresponse consists of a status code, response headers, and optionally some content. Thevalid status codes and response headers are defined by the WebDAV specification.

WebDAV resource — A resource (for example, an HTML document, GIF image, orfolder) that can be accessed via the WebDAV protocol. WebDAV‑compliant resourcesusually reside in a content repository.

WebDAV client — A client program that is capable of creating and making WebDAVrequests to a WebDAV server. A WebDAV client should also be able to understand andinterpret the WebDAV response and perform the appropriate action. Examples of clientprograms include Microsoft Word and PowerPoint.

WebDAV Server — A server program that is capable of processing a WebDAV requestand then sending the appropriate WebDAV response to the WebDAV client.

URI — A Universal Resource Identifier, which uniquely identifies resources. ForDocumentum WebDAV Services, the URI indicates the correct cabinet/folder/documentin the repository.

Communication sequence

HTTP is a stateless protocol that consists of requests and responses in which the HTTPclient always initiates the communication. Following is an example of a sequence ofcommunication between a WebDAV client and a WebDAV server:

1. The WebDAV client initiates the first request.

2. The WebDAV server may respond back for authorization.

3. The WebDAV client prompts the user to enter authentication information.

4. The WebDAV client resubmits the previous request, this time including theauthorization information.

5. The WebDAV server authenticates the user and processes the request.



The WebDAV server maintains the client session information and processes subsequentrequests without forcing users to authenticate for every request thereafter.

For more information about WebDAV request methods, see Methods, page 13.

Methods

The HTTP specifies the different methods that can be issued in an HTTP request. TheWebDAV protocol adds various methods to the HTTP and specifies the communicationmechanism between a WebDAV server and a WebDAV client. Typically more complexthan HTTP requests, WebDAV requests and responses often use XML in the requestand/or response body to encapsulate data.

WebDAV Services translates WebDAV method calls to Documentum DFC calls.

WebDAV Services supports all WebDAV Class 2 compliant requests.

Table 1, page 13 outlines the WebDAV and HTTP methods that are implemented byWebDAV Services. It describes the semantics of each method as designated in theWebDAV specification, and outlines any variance to the semantics as implementedby Documentum.

Table 1. WebDAV methods and semantics

Method WebDAV semantics Documentum semantics

GET Retrieve the contents of theresource specified by theURI.

Return the content of theprimary rendition of thedocument referenced bythe URI.

PUT Update the content of theresource specified by theURI with the content sentin the request body.

Check in a newer versionof the document using thecontent sent in the requestbody.

OPTIONS List the methods that canbe issued to the specifiedserver.

Return the list of methodsthat the WebDAV clientcan issue to the specifiedrepository. The methodsallowed are determinedby the permissions ofthe current user in therepository.




DELETE Delete the resourcespecified by the URI.

Delete the repository objectlocated at the specifiedURI.

LOCK Lock the resource specifiedby the URI. Issue a locktoken to theWebDAV clientfor future requests to thelocked resource.For moreinformation about locks,see Locks, page 15.

Create a WebDAV lock forthe requested object, issue aLock Token to theWebDAVclient for future requeststo this locked resource,and lock the object in therepository.

UNLOCK Unlock the resourcespecified by the URI.

Unlock the object in therepository. Remove theWebDAV lock for thespecified object.

PROPFIND Find the properties of theresource specified by theURI. The WebDAV clientcan submit a request forall properties, specificproperties, or propertynames.

All properties: Find allthe attribute values of thedocument/folder specifiedby the URI. The attributevalues are returned inthe response body in theXML format defined by theWebDAV specification.

Specific properties: Sameas above except onlyretrieve the attribute valuesof the specific propertiesrequested in the body ofthe XML.

Property names: Retrievethe names of all theproperties definedfor that particulardocument/folder.

PROPPATCH Set, update, or removeproperties of the resourcespecified by the URI. Thenew property values arespecified in the requestbody.

Set, update, or removeproperties of thedocument/folder specifiedby the request URI.




COPY Create a copy of theresource specified by theURI in the destinationspecified in the requestheader. All the propertiesof the source resource mustbe recreated in the newlycreated resource.

Create a copy of thedocument/folder in thefolder location specified bythe URI in the destinationheader. The newly createddocument/folder will be anexact copy of the originalas far as content andproperties are concerned.After the copy, both thesource and destinationobjects can be modifiedseparately.

MOVE Move the resourcespecified by the URI tothe destination specifiedin the request header(the equivalent of copy,followed by a delete ofthe source). Also, used torename a document/folder.

Modify the parent folderof the document/folderspecified by the requestURI. The document/folderwill be updated to have thefolder specified by the URIin the destination headeras its new parent.

MKCOL Make a new collectionresource at the locationspecified by the requestURI.

Create a folder at thelocation specified by therequest URI. If the MKCOLmethod is called withouta request body, an emptyfolder will be created at thespecified location.

Locks

In translating WebDAV method calls to Documentum DFC calls, WebDAV Servicesmust interpret locks as defined by the WebDAV protocol in a manner that makes sensein a DFC context. The protocol specifies different locking mechanisms for resources(exclusive locks, shared locks, expiring locks), and the handing out of lock tokens toclients when a LOCK request is received. Since Content Server does not support sharedlocks, expiring locks, or the generation of lock tokens, WebDAV Services introducesa new persistent object type called webdav_lock that contains all the lock attributesrequired to support WebDAV semantics. So, when WebDAV Services locks a document,it creates an instance of the webdav_lock object, which has attributes that refer back



to the original document being locked. The attributes include the name of the userrequesting the lock, the date/time the lock was requested, the lock expiration date, thelock token issued to the client, and the type of lock.

The creation of the new type webdav_lock in the repository occurs during installation ofthe DocApp after WebDAV Services is deployed. For more information, see Installingthe WebDAV DAR file, page 36.

Lock cleanups

When WebDAV Services creates a webdav_lock that has a specified time‑out period, itschedules an automatic lock cleanup activity to run when the lock expires. If the lockis refreshed or an unlock is requested before the expiration time, the lock cleanup iscancelled.

The lock cleanup request checks to see if the lock_expiration date is in the past and if it is,it deletes the webdav_lock object specified by the lock_token and unlocks the documentin the repository (if it locked the document during its LOCK request). If the webdav_lockspecified by the lock_token has a time‑out in the future, the WebDAV client has likelymade a request to refresh the lock and extend its time‑out period. If the webdav_lockspecified by the lock_token no longer exists, the user probably unlocked the document.

You can schedule lock cleanup activities at exactly the same time as thelock_expiration_date, so that there is no period of time in which the document is lockedbeyond the lock_expiration_date. However, it is recommended that you give someadditional time (a grace period) to the WebDAV client to make its request. This allows forexternal considerations such as network speed and bandwidth. You can define a graceperiod that is suitable for your environment by making modifications to the WebDAVServices configuration file. For more information, see Configuring the servlet, page 53.

System administrators can manually initiate lock cleanups and view scheduled lockcleanups using the WebDAV Services Administrator. For more information, see Cleaningup WebDAV orphan locks, page 63 and Listing scheduled Lock Cleanup jobs, page 64.

Mac resource forks

WebDAV Services provides repository access to Macintosh users, as well as Windowsusers. Therefore, it is important that WebDAV Services handle the two components of aMacintosh file: the data fork and the resource fork.



• The data fork of a Macintosh file contains the file’s data. For example, the data forkof a document file might contain the text of a letter, while the data fork of other filetypes might contain an image. This is generally all of the data required to use thefile on a Windows PC.

• The resource fork of a Macintosh file contains the file’s resources. If the file isan application, the resource fork typically contains resources that describe theapplication’s menus, dialog boxes, icons, and even the executable code of theapplication itself. If the file is a document, its resource fork typically containspreference settings, window locations, and document‑specific fonts, digitizedsounds, thumbnail icons, and so forth.

Both parts are used by the Macintosh operating system in file management and storage.Unlike the Macintosh, however, PC files only have one associated file. Accessing PCfiles on a Macintosh is no problem—the PC file becomes the data fork of a Macintoshfile. When Macintosh files are accessed from a PC, however, only the contents of theMacintosh data fork can be used. Once a Macintosh file is copied to the PC, the resourcefork is usually lost.

For its OS X release, Macintosh moved resources into the data fork of a separate resourcefile. The Carbon APIs in Macintosh OS X can read and process resources in a resourcefile’s data fork as if they were in the resource fork. Most computing environmentsrecognize single forks only and tend to lop off resource forks. Moving the resources out ofthe resource forks enables applications to be seamlessly moved around between differentfile systems and makes it possible to exchange documents without the loss of resourcedata between Macintosh and non‑Macintosh systems, including most Web servers.

Macintosh type and creator codes

The Documentum Content Server has a table of format objects that contain informationon all the file formats that it is capable of supporting. The Content Server only recognizesformats for which there is a format object in the repository. If the format is not recognizedby the server, the document will be registered with a format of unknown.

When a user adds a document to the repository via a WebDAV‑enabled client, WebDAVServices uses the Content Server to help it recognize the content of the document. This isparticularly important when ingesting documents using WebDAV‑enabled clients onthe Macintosh. If the format is not recognized properly, the Macintosh file may notbe retrieved properly from the repository. As discussed in the previous section, theresource fork holds resources (icons, fonts, menus, sounds, and so on). Since eachresource fork can hold many resources, it has a specific structure that allows programsto find and access a particular resource quickly. The data fork can hold any type ofdata (text, images, and so on) and does not have a required structure like the resourcefork. Macintosh resource forks are generally of no use on other file systems (Windowsor UNIX), but it is possible for application programs to convert specific resources to a



format that is readable on other file systems. In general, the contents of the Macintoshdata fork are usually all that can be used on other non‑Macintosh file systems.

It is useful to have a way to identify the type of file as well as which application createdit. The Macintosh file system stores this additional information with the file name. Theseare two four‑character fields called the type and creator. The type field tells the programwhat type of data is in each file so it can parse it properly. It also allows a program tofilter files in an open file dialog box so the user can only open files of a certain type. Thecreator field is unique for each Macintosh application. When an application creates a file,it puts a creator signature in this field which identifies that this application should belaunched when a user double‑clicks on the file’s icon.

Once a Macintosh file is copied to another operating system’s file system, the resourcefork, type, and creator information are lost unless the file is encoded with MacBinaryor a similar format (HQX, SIT) that saves the Macintosh specific data with the file. Thisway the file can exist on a single fork machine (Windows, UNIX) or be transmitted anddecoded at the other end with all Macintosh information intact.

Preserving resource forks with MacBinary

Most Macintosh WebDAV‑enabled clients make use of the MacBinary encodingscheme to ensure that the resource fork and data fork of the file are preserved.MacBinary‑encoded files consist of three components: the file information (creation date,modification date, Macintosh creator code, Macintosh type, file name, and so on), theresource fork, and the data fork.

Windows file systems have a different way of identifying a file’s type. This is done withan extension to a file name. The extension consists of the characters after a period atthe end of the file name. Instead of a separate creator field like with Macintosh, eachextension is associated with an application. This is much less flexible than the typeand creator fields on a Macintosh.

WebDAV Services is capable of preserving Macintosh files because it can receive andsend content that is MacBinary‑encoded. When WebDAV Services receives a MacBinaryfile, it looks at its Macintosh type and Macintosh creator code and tries to determinewhich format it could best be represented as in the repository. To do this, it searches thelist of known format objects to find the one with the matching Macintosh creator codeand Macintosh type. If no format object is found, it looks for a file extension on the filename. It then searches all known format objects for one that matches this extension. If nofile extension is found, the document is registered as unknown.

You may find that documents are not always being registered as the formats you areexpecting. This can be fixed by modifying the format objects in the repository usingDocumentum Administrator to accurately reflect the Macintosh type/creator code to



file extension mappings that you prefer. For a description of how to do this, see theDocumentum Content Server Administrator’s Guide.


Chapter 2Preparing for Deployment

This chapter outlines predeployment tasks required for both Windows and UNIX hosts.

Predeployment requirements for WindowsThis section describes the prerequisites for a successful WebDAV Services deployment. Itcontains software requirements, a predeployment checklist, and notes about the DFC.It is important that you review these sections prior to deployment. Before you beginthe deployment process, you should also verify that you have access to the DownloadCenter (https://EMC.subscribenet.com/control/dctm/index) so you can retrieve thedeployment files.

This section includes:• Software requirements, page 21• Predeployment checklist, page 22• Notes about the DFC, page 23

Software requirements

The following software is required to run WebDAV Services on a Windows host. This listillustrates the order in which the software should be deployed.

• Windows operating system on WebDAV server host.• Documentum Content Server (recommended on a separate host).• Application server on the WebDAV server host. See theWebDAV Services Release

Notes for supported application servers.


https://documentum.subscribenet.com




Preparing for Deployment

• Documentum Application Installer for Windows, running on a machine thatis accessible to the repository to be configured with WebDAV Services. TheDocumentum Application Installer for Windows is available on the DownloadCenter (https://EMC.subscribenet.com/control/dctm/index). For more information,see the Documentum Application Installer Installation and Release Notes.

The JDK and DFC are deployed automatically by the WebDAV Services WAR file (exceptas noted above). It is not necessary to deploy them prior to deploying WebDAV Services.

Caution: You must install the correct version of each software product that runswith WebDAV Services before you begin the deployment. See the WebDAVServices Release Notes for the software versions certified to run with your version ofWebDAV server.

Predeployment checklist

This section provides you with a predeployment checklist so you can ensure you have allthe information you need to deploy WebDAV Services.

Table 2. Predeployment checklist for Windows

Required value Comments Your value

Connection Broker hostname

If the correct DFC has notyet been deployed on thehost, you will be promptedfor the Primary ConnectionBroker host name servicingthe repository youwant to configure withWebDAV Services duringdeployment.

BEA WebLogic domainname (if applicable)

You may need to enterthis information if it is notautomatically detected bythe WAR file.

BEA WebLogic servername (if applicable)






Virtual directory name The virtual directorywill be created on theapplication server duringdeployment. The name ofthe virtual directory willdetermine how WebDAVServices will be accessed byWebDAV‑enabled clients.By default, the virtualdirectory is dmwebdav.

Application server portnumber

Enter a port numberthat was configured forWebDAV in the applicationserver. If you are usingthe default, it will beautomatically supplied.

Default repository name The name of the repositorythat WebDAV Serviceswill access by default if norepository is specified inthe WebDAV URL.

Repository user name,password, and domain(optional) if anonymousauthentication is selected

If anonymousauthentication is selected,the login credentials willbe used for every user whologs into the repository.

Notes about the DFC

The correct version of Documentum Foundation Classes (DFC) must be deployed on theWebDAV Services host. If not already deployed, the correct DFC version is deployedautomatically by the WebDAV Services WAR file.

If a version of the DFC earlier than that which is certified for this version of WebDAVServices exists on the host, it must first be uninstalled, and the machine restarted toremove any DLL files. If the correct DFC is already deployed on the host, it will bere‑deployed by the WebDAV Services WAR file, using the same deploy parameters.If a newer version of DFC is already deployed on the host, you are given a warningduring the deployment that this DFC version has not been certified with this version of



WebDAV Services. It is recommended that you uninstall the newer version of the DFC,and let the WebDAV Services WAR file put the correct version on the machine.

For more information about what versions of DFC are certified to run with WebDAVServices, refer to theWebDAV Services Release Notes.

Predeployment requirements for UnixThis section describes the prerequisites for a successful WebDAV Services deployment.It contains software requirements, permissions requirements, instructions for settingenvironment variables, a predeployment checklist, and notes about the DFC. It isimportant that you review these sections prior to deployment. Before you begin thedeployment process, you should also verify that you have access to the Download Center(https://EMC.subscribenet.com/control/dctm/index), so you can retrieve the deploymentfiles.

This section includes:• Software requirements, page 24• Permissions, page 25• Setting environment variables, page 25• Predeployment checklist, page 27• Notes about the DFC, page 28

Software requirements

The following software is required to run WebDAV Services on UNIX. This list illustratesthe order in which the software must be installed.

• Solaris, Linux, or AIX operating system on WebDAV server host.• Documentum Content Server (on the WebDAV Server host or a separate host).• Application server; see theWebDAV Services Release Notes for supported application

servers.DFC is installed automatically by the WebDAV Services WAR file. It is not necessary toinstall it prior to deploying WebDAV Services.

Caution: You must install the correct version of each software product that runswith WebDAV Services before you begin the deployment. See the WebDAVServices Release Notes for the software versions certified to run with your version ofWebDAV server.




Permissions

For all UNIX deployments, you must have the proper permissions on all deploymentfiles.

Setting environment variables

UNIX deployments require that you have the correct environment variables set priorto deploying WebDAV Services.

Set these variables in the deployment owner’s .cshrc file (C shell) or .profile file (Bourneor Korn shells). Alternatively, set the variables in a file called by the .cshrc file or .profilefile or in other fashions permitted by UNIX.

Some of these environment variables may already exist, and if you have otherDocumentum products installed on your system, some of the values may exist as well.Perform as many of the steps as you can. For information on how these variables areused by DFC, see the Documentum Foundation Classes (DFC) Installation Guide.

Documentum recommends that you do not manually change the classpath. If you domanually change the classpath, an application re‑deployment may fail to update theclasspath correctly.

Log in as the user who is the application server instance owner. Do not log in as root.Set the following environment variables and create the corresponding directories ifthey do not exist:

Table 3. Required environment variables

Environment variable Description Required values

DOCUMENTUM Specifies the path to theDocumentum homedirectory in whichDocumentum applicationsare installed.

Any directory in thedeployment owner’senvironment. Example:

DOCUMENTUM=/local/

documentum




DOCUMENTUM_SHARED

Specifies the path to theshared Documentumdirectory in which DFCand any other shared filesare installed.

Any directory in thedeployment owner’senvironment. Example:

DOCUMENTUM_SHARED=

$DOCUMENTUM/share

DFC_DATA Specifies the path to theparent of theDocumentumconfiguration directorywhich includes the fileslog4j and dbor.

The share directory islocated by default underthe Documentum homedirectory. Example:

DFC_DATA=$DOCUMENTUM/

share

JAVA_HOME Specifies the path tothe JDK root directionon deployments usingApache Tomcat.

Example:

JAVA_HOME=$DOCUMENTUM_

SHARED/jdk/

LD_LIBRARY_PATH(Solaris and Linux) orLIBPATH (AIX)

Points to the location ofshared libraries requiredby the server. Theshared libraries includesupport for LDAP, Java,federations, and otherfeatures.

You can specify the location ofmultiple shared libraries fordifferent products withcolon‑separated paths.Examples:

LD_LIBRARY_PATH=

$DOCUMENTUM_SHARED/

dfc:/usr/lib:$JAVA_

HOME/jre/lib

LIBPATH=$DOCUMENTUM_

SHARED/dfc:/usr/

lib:$JAVA_HOME/jre/lib

For deployments onBEA WebLogic, appendthe following to theLD_LIBRARY_PATH:

$BEA_HOME/weblogic92/

server/lib/linux/i686


server/lib/linux/ia64


server/lib/linux/s390




BEA_HOME, if youare deploying on BEAWebLogic

The full path to the WebLogichome directory.

WAS_HOME, if youare deploying on IBMWebSphere

The full path to theWebSpherehome directory.

CATALINA_HOME, ifyou are deploying onApache Tomcat

The full path to the Tomcathome directory.

Predeployment checklist

This section provides you with a predeployment checklist so you can ensure you haveall the information you need to install WebDAV Services.

Table 4. Predeployment checklist for UNIX


Connection Broker hostname

If the correct DFC has notyet been installed on thehost, you will be promptedfor the primary ConnectionBroker host name servicingthe repository youwant to configure withWebDAV Services duringdeployment.

BEA WebLogic domainname (if applicable)


BEA WebLogic servername (if applicable)





Virtual directory name The virtual directorywill be created on theapplication server duringdeployment. The name ofthe virtual directory willdetermine how WebDAVServices will be accessed byWebDAV‑enabled clients.By default, the virtualdirectory is dmwebdav.

Application server portnumber

Enter a port numberthat was configured forWebDAV in the applicationserver. If you are usingthe default, it will beautomatically supplied.

Default repository name The name of the repositorythat WebDAV Serviceswill access by default if norepository is specified inthe WebDAV URL.

Repository user name,password, and domain(optional) if anonymousauthentication is selected

If anonymousauthentication is selected,the login credentials willbe used for every user whologs into the repository.

Notes about the DFC

The correct version of Documentum Foundation Classes (DFC) must be installed on theWebDAV Services host. If not already installed, the correct DFC version is installedautomatically by the WebDAV Services WAR file.

If a version of the DFC earlier than that which is certified for this version of WebDAVServices exists on the host, it must first be uninstalled (refer to the DocumentumFoundation Classes Installation Guide for the uninstall procedure). If the correct DFC isalready installed on the host, it will be re‑installed by the WebDAV Services WAR file,using the same install parameters. If a newer version of DFC is already installed on thehost, you are given a warning during the deployment that this DFC version has not beencertified with this version of WebDAV Services. It is recommended that you uninstall



the newer version of the DFC, and let the WebDAV Services WAR file put the correctversion on the machine.

For more information about what versions of DFC are certified to run with WebDAVServices, refer to theWebDAV Services Release Notes.


Chapter 3Deploying WebDAV Services

After you complete the required predeployment tasks, deploy WebDAV Services on the applicationserver host. Install the WebDAV DocApp and WebDAV source on the Content Server. Check theWebDAV Services Release Notes for information on the application servers, operating systems, and othersoftware in the environment that are certified for this product.

Deployment procedures include:• Enabling DFC connections to repositories, page 32• Configuring the web.xml file, page 34• Configuring log file locations, page 35• Deploying the WAR file, page 35• Installing the WebDAV DAR file, page 36• Installing the WebDAV source for Content Server, page 39

Download and unpack the WAR fileThe first step in deploying and configuring WebDAV Services is to download andunpack the files necessary for deployment.

To download and unpack the WebDAV Services WAR file:

1. Download the WAR file from the EMC download site to a temporary directoryon the application server host.

2. If deploying on Tomcat, ensure that the application server is not running.

3. Unpack the WAR file.

4. Modify the dfc.properties file following the instructions in Enabling DFC connectionsto repositories, page 32. You must perform this procedure before attempting toconnect to Documentum repositories.


https://emc.subscribenet.com

Deploying WebDAV Services

5. Configure the web.xml file following the instructions in Configuring the web.xmlfile, page 34. You must perform this procedure before attempting to connect toDocumentum repositories.

6. Configure the log file locations following the instructions in Configuring log filelocations, page 35. You must perform this procedure before attempting to connectto Documentum repositories.

Enabling DFC connections to repositoriesYou must provide connection broker and global registry values in dfc.properties beforeyour application can connect to repositories.

A global registry of Content Server version 6 is required for WebDAV Services. Theglobal registry is a central repository that serves several purposes:• Deploys service‑based business objects (SBOs)• Stores network location objects• Stores persistent user preferences, unless another repository is configured in app.xmlThe System Deployment Guide contains information about enabling a repository as aglobal registry.

You can copy information from the dfc.properties file that was generated by the ContentServer installer on your global registry host. The generated dfc.properties file containsthe connection broker address and the encrypted global registry user login information.

To configure connections in dfc.properties before deployment:

1. Unpack the application WAR file.

2. Open the file dfc.properties in <WebDAV_HOME>\WEB‑INF\classes.

3. Add the fully qualified hostname for the docbroker to the following key. You canadd backup hosts by incrementing the index number within brackets.dfc.docbroker.host[0]=host_name

4. If you wish to use a port for the docbroker other than the default of 1489, add aport key to dfc.properties:dfc.docbroker.port[0]=port_number

5. Add the global registry repository name to the following key:dfc.globalregistry.repository=repository_name

6. Add the username of the dm_bof_registry user to the following key:dfc.globalregistry.username=dm_bof_registry_user_name



The global registry user, who has the username of dm_bof_registry, has read accessto objects in the /System/Modules and /System/NetworkLocations only.

7. Add an encrypted password value for the following key:dfc.globalregistry.password=encrypted_password

You can either copy the username and encrypted password from the dfc.propertiesfile on the global registry Content Server host, or you can select another globalregistry user and encrypt the password using the following command from acommand prompt (assumes the directory containing javaw.exe is on the systempath):java cp dfc.jar com.documentum.fc.tools.RegistryPasswordUtilspassword_to_be_encrypted

To use the dfc.properties file information from the global registry ContentServer repository:

1. On the global registry repository host, locate the Content Server deploymentdirectory. On Windows hosts, the default deployment directory is C:\Documentum.On UNIX hosts, this directory is specified by the environment variable$DOCUMENTUM.

2. Open the file dfc.properties that is located in the classes subdirectory.

3. Copy the following keys and their values from the file:dfc.docbroker.host[0]=addressdfc.docbroker.port[0]=1489dfc.globalregistry.repository=repository_namedfc.globalregistry.username=usernamedfc.globalregistry.password=encrypted_password

4. Unpack the application WAR file.

5. Open the dfc.properties file located in <WebDAV_HOME>\WEB‑INF\classes withinthis expanded WAR file directory.

6. Paste in the values that you copied from the global registry dfc.properties.

7. Use a text editor to configure additional properties in this file or make any changesto it.

8. Save the dfc.properties file and deploy the application.

Note: If you create a new WAR file from this application directory, you mustensure that any paths that you specify in dfc.properties are valid directories onthe application server and that the application server instance owner has writepermission on the specified directories.



Configuring the web.xml fileYou must add repository and port number information to the web.xml file. Thisconfiguration is mandatory.

If you are using Anonymous authentication instead of Basic (which is the default settingin web.xml), you must modify certain parameters in this file as well. This configurationis optional.

These configurable parameters are described as follows:• docbase— This value specifies the name of the default repository that is exposed

through WebDAV Services. If an alternate repository name is not specified in theURL, WebDAV Services uses this repository name.

• default‑port— This is the default port which the servlet engine is configured to runon. There are different default port numbers for each application server. If yourserver deployment has been modified to run on a different port number, updateit in this web.xml file as well.

• auth‑type— This value specifies the authentication mechanism to be used toconnect to the repository. The default value is basic, which prompts users to entera name and password for authentication. The other possible value is anonymous,which means the anonymous‑user, anonymous‑password, and anonymous‑domainmust be specified. When WebDAV Services connects to the repository throughanonymous authorization, every user with access to WebDAV Services can connectto the repository without authentication.

• anonymous‑user— The user name that permits WebDAV Services to connect to therepository when the auth‑type value is anonymous.

• anonymous‑password— The password that permits WebDAV Services to connect tothe repository when the auth‑type value is anonymous.

• anonymous‑domain—An optional parameter that is used by WebDAV Services toconnect to the repository when the auth‑type value is anonymous.

To configure the web.xml file:

1. Locate the web.xml file at <WebDAV_HOME>\WEB‑INF.

2. Open the web.xml file in any XML or text editor.

3. Specify the appropriate values for the docbase and default‑port parameters.

4. Only if using Anonymous authentication, modify the values for these parameters:• auth‑type• anonymous‑user• anonymous‑password• anonymous‑domain



5. Save and close the web.xml file.

Note: For information about other parameters in the web.xml file, see Configuringthe servlet, page 53.

Configuring log file locationsA default location for log files is contained in log4j.properties under<WebDAV_HOME>\WEB‑INF\classes. For Windows, the default location is C:\logs.

Log file locations for Windows are specified in the following appenders:log4j.appender.F1.File=C\:/Documentum/logs/log4j.loglog4j.appender.WEBDAVAppender.File=C\:\\logs\\WEBDAV_log.txtlog4j.appender.ResponseAppender.File=C\:\\logs\\Response_log.txtlog4j.appender.FILE_TRACE.File=C\:/Documentum/logs/trace.loglog4j.appender.file.File=C\:/Documentum/logs/wdk.log

Similarly, log file locations for UNIX are specified as follows:log4j.appender.F1.File=/export/torbbq2/logs/log4j.loglog4j.appender.WEBDAVAppender.File=/export/torbbq2/logs/WEBDAV_log.txtlog4j.appender.ResponseAppender.File=/export/torbbq2/logs/Response_log.txtlog4j.appender.FILE_TRACE.File=/export/torbbq2/logs/trace.loglog4j.appender.file.File=/export/torbbq2/logs/wdk.log

You must ensure that log folders exist at the locations specified in log4j.properties.

See Activating logging, page 54 for additional information about logging.

After performing the configuration tasks outlined in this chapter, you must restart theapplication server. See Starting and stopping the application server on Windows, page42 or Starting and stopping the application server on UNIX, page 43.

Deploying the WAR filePerform the following procedure to deploy the WAR file on the application server.

To deploy the WebDAV Services WAR file:

1. Add or migrate customizations from previous WebDAV Services versions.

2. Re‑archive the WAR file.

3. Deploy the WAR file according to the deployment instructions in your applicationserver documentation.



Installing the WebDAV DAR fileAfter you install WebDAV Services and before you use WebDAV Services, you mustinstall a DAR file on each repository you plan to access through WebDAV Services.The WebDAV DAR file does the following:• Creates the webdav_lock type in the repository.• Installs the dm_method named davLockCleanup.• Creates a job in the repository named dm_davLockCleanupJob, which does periodic

cleanups of webdav_lock objects that have expired (orphaned locks). This job invokesthe davLockCleanup method and, by default, is scheduled to run every two hours.

Installing a DAR files requires an installation of Documentum Composer that can accessthe repository where WDK‑based client application is installed.

To enable clustering, the DAR must be deployed to a global registry repository.

Note: You must have Superuser privileges for the repositories in which you want toinstall the DAR file.

Procedures are provided for installing these DAR files in Windows repositories andUNIX repositories.

To install the WebDAV DAR file in a Windows repository:

1. Log in to a machine with Documentum Composer.

2. Download the DAR file from the EMC download site to a temporary directory onthe Composer host.

3. Unzip the downloaded DAR file.

4. Select Start > Programs > Documentum > Composer.

5. Connect to the WDK‑based client application repository as a user with Superuserprivileges. Enter the repository, user name, password, and domain when promptedand click OK.The domain is the operating system domain against which your user account isauthenticated. You might not be required to enter the domain.

Note: Your repository user account must have the Superuser privilege.

Superuser privilege is the highest level of user privilege in a repository. Users withthe Superuser privilege have a minimum access level of Read for all sysobjects. Theyalso have the ability to change the object‑level permissions of any object.

For more details about Superuser abilities and to learn how to grant superuserprivilege to a user, see the Content Server Administration Guide.

6. In the Select DAR file Archive dialog box, click Browse to find the WebDAV DARfile folder.


https://emc.subscribenet.com


Caution: EMC Documentum recommends that you do not change the name ofthe DAR file archive folder because Composer uses it to install the DAR filearchive and the DAR file archive folder might be specified in paths (such asin the XML configuration file or location aliases).

7. Select the folder and click OK.By default, the installer log file is named WebDAV_installerLog.html and is savedto c:\TEMP.

a. To select a different location for the installer log, click Browse (next to the Pathname field) and select a directory.

b. To specify a different filename, type a new one in the File name field.

8. Click OK in the Select DAR file Archive dialog box.You are returned to the main window.

9. Click Start Installation.When a message box is displayed that states, ʺThis will take a few minutes tocomplete,ʺ click Yes to continue.If a message box is displayed that states that there are connected users, click Yes tocontinue.If you specified aliases for objects in your DAR file, then the Resolve Alias dialogbox is displayed.

10. In the Resolve Alias dialog box, select the alias or folder in the repository underValue:

a. To find the appropriate folder, click Browse, select the folder (do not double‑clickthe folder to open it) and then click Select.

b. Select the corresponding user or group from the drop‑down list.

11. Click OK.Composer installs the DAR file archive.If errors occur and the text, ʺAbort transaction,ʺ is displayed in the Installation Statuswindow, do not exit Composer. Refer to the Documentum Composer User Guide.

12. Stop and restart WebDAV Services. See Starting and stopping the application serveron Windows, page 42 for more information.

To install the WebDAV DAR file in a UNIX repository:

1. Log in to a Windows host where the Documentum Composer is installed.

2. Ensure that the dfc.properties file on the host is pointing to a connection brokerto which the UNIX repository projects.



For example, if the repository projects to a connection broker called Troy, ensurethat Troy is listed in the dfc.properties file. The dfc.properties file is in theC:\Documentum\config or $DOCUMENTUM/config folder.

3. Use FTP or another protocol to transfer the WebDAV DAR file from the ContentServer host to a temporary folder on the Windows host.

4. On the Windows host, click Start > Programs > Documentum Composer.The Documentum Login dialog box is displayed.

5. In the Repository field, select the repository where you are installing the DAR file.

6. Enter the user name and password of a user who has Superuser privileges in therepository.

7. Click OK.The Select DAR file Archive dialog box is displayed.

8. Browse to $DM_HOME/product/6.5/install/DAR files/WebDAV_Services.Do not change the name of the DAR file archive.

9. Click OK.

10. If required, specify a different Composer log file name and location.Documentum recommends using the path to the DAR file as the path name.

11. Click OK.The DAR file Installer dialog box is displayed.

12. Verify that the information on the dialog box is correct.

13. Click Start Installation.A prompt is displayed.

14. Click OK.

15. If the Connected Users dialog box is displayed, click Yes.• If the DAR file Installer dialog box displays the following, the installation

succeeded:<P>COMMIT TRANSACTION</P>.xxxx INSTALLATION DONE xxxx.

• If theDAR file Installer dialog box displays the following, the installation failed:<P>ABORT TRANSACTION</P>.

16. Click Quit Installer.

17. Repeat this procedure in each repository where you plan to run WebDAV Services.See Starting and stopping the application server on UNIX, page 43 for moreinformation.



Installing the WebDAV source for ContentServer

After you install WebDAV Services, you must install the WebDAV source on the ContentServer. Installing the WebDAV source copies the three job files necessary for ContentServer to run lock cleanup jobs.

The WebDAV source is located in the postdeployment directory specified during theWebDAV Services deployment.

Procedures are provided for both Windows and UNIX hosts.

To install the WebDAV source for Content Server on Windows:

1. Navigate to the WebDAV Services postdeployment directory specified during theWebDAV Services deployment. The default location is C:\Documentum\WebDAVServices.

2. Open the DAV_Lock_Cleanup_Job_Support_Files folder.

3. Open the folder for your Content Server platform (Windows).

4. Unzip the DAV_Lock_Cleanup_Job_Support_Files.zip file into the Content Servermachine at the following location:<server_install_location>\product\6.5\

5. When complete, a new directory called webdav should be created at a locationsimilar to the following: C:\Documentum\Product\6.5\webdav.

To install the WebDAV source for Content Server on UNIX:

1. Navigate to the WebDAV Services postdeployment directory specified duringthe WebDAV Services deployment (for example, $DOCUMENTUM_SHARED/WebDAV_Services).

2. Open the DAV_Lock_Cleanup_Job_Support_Files folder.

3. Open the folder for your Content Server platform (such as Linux, Solaris, or AIX).

4. Unzip the DAV_Lock_Cleanup_Job_Support_Files.zip file into the Content Servermachine at the following location:<server_install_location>\product\6.5\



5. When complete, a new directory called webdav should be created at a locationsimilar to the following: C:\Documentum\Product\6.5\webdav.


Chapter 4Completing the Deployment

After you deploy WebDAV Services, there are additional procedures that you may need to perform inorder to finish and verify the deployment. This chapter contains:• Configuring the config.xml file, page 41• Applying the MS update for Vista, page 41• Starting and stopping the application server on Windows, page 42• Starting and stopping the application server on UNIX, page 43• Verifying the deployment, page 44

Configuring the config.xml fileIf WebDAV Services is deployed on BEA WebLogic, you must add the following line(in bold) to the config.xml file:<securityconfiguration>...<enforcevalidbasicauthcredentials>false</enforcevalidbasicauthcredentials></securityconfiguration>

If you fail to perform this configuration, users will be unable to connect to the repositoryunder Basic authentication.

Applying the MS update for VistaTo avoid authentication issues on Microsoft Vista, you need to installthe Microsoft Update for Web Folders. This update is available at:http://support.microsoft.com/default.aspx?scid=kb;EN‑US;907306


http://support.microsoft.com/default.aspx?scid=kb;EN-US;907306

Completing the Deployment

Starting and stopping the application serveron Windows

After deploying WebDAV Services, you can start the application server from theWindows Services window or from the command line. You can stop the applicationserver in the same manner. Follow the appropriate procedure outlined below to changethe state of the application server manually.

Controlling the Windows/Apache Tomcat applicationserver

If running Apache Tomcat as a service, you can start and stop Tomcat through theWindows Services tool. Alternatively, you can start and stop Tomcat manually.

To start/stop the Windows/Apache Tomcat application server manually:

1. Open a command prompt window.

2. Navigate to the Tomcat deployment directory.

3. Navigate to the /bin directory.

4. To start the application server, enter the command startup.bat.To stop the application server, enter the command shutdown.bat.

Controlling the Windows/BEA WebLogic applicationserver

If running BEA WebLogic as a service, you can start and stop WebLogic through theWindows Services tool. Alternatively, you can start and stop WebLogic manually.

To start/stop the Windows/BEA WebLogic application server manually:


2. Navigate to the WebLogic deployment directory.

3. Navigate to the /user_projects/domains/dmwebdav directory.

4. To start the application server, run the script startDocumentum.cmd.To stop the application server, enter CtrlC on the keyboard.



Controlling the Windows/IBM WebSphere applicationserver

If running WebSphere as a service, you can start and stop WebSphere through theWindows Services tool. Alternatively, you can start and stop WebSphere manually.

To start/stop the Windows/IBM WebSphere application server manually:

1. Open a Windows Explorer window.

2. Navigate to the WebSphere deployment directory (for example, C:\ProgramFiles\WebSphere\AppServer).

3. Open the bin folder.

4. To start the application server, double‑click the startServer.bat file.To stop the application server, double‑click the stopServer.bat file.

Starting and stopping the application serveron UNIX

After deploying WebDAV Services, you can start the application server from a commandprompt. You can stop the application server in the same manner. Follow the appropriateprocedure outlined below.

Controlling the UNIX/Apache Tomcat application serverTo start/stop the UNIX/Apache Tomcat application server:


2. Navigate to the Tomcat deployment directory.

3. Navigate to the /bin directory.

4. To start the application server, enter the command ./startup.sh.To stop the application server, enter the command ./shutdown.sh.



Controlling the UNIX/BEA WebLogic application serverTo start/stop the UNIX/BEA WebLogic application server:


2. Navigate to the WebLogic deployment directory.

3. Navigate to the directory /user_projects/domains/<domain_name>.

4. To start the application server, enter the command ./startWebLogic.sh.To stop the application server, enter the command ./stopWebLogic.sh.

Controlling the UNIX/IBM WebSphere application serverTo start/stop the UNIX/IBM WebSphere application server:


2. Navigate to the WebSphere deployment directory $DOCUMENTUM (for example,/documentum/WebSphere/AppServer/).

3. Navigate to the bin directory.

4. To start the application server, enter the command ./startServer.sh

<server_name>.

To stop the application server, enter the command ./stopServer.sh

<server_name>.

Verifying the deploymentTo verify that WebDAV Services is deployed successfully after performing alldeployment and configuration (Configuring the web.xml file, page 34, and Configuringlog file locations, page 35) procedures, log in to WebDAV Services Administrator.Ensure that the repository appears in the repository listing. See Chapter 8, WebDAVServices Administrator for information and procedures relating to WebDAV ServicesAdministrator.


Chapter 5Removing WebDAV Services

This chapter describes how to remove WebDAV Services from the application server. It containsthe following sections:

• Removing WebDAV Services on Windows, page 45• Removing WebDAV Services on UNIX, page 45

Removing WebDAV Services on WindowsThis section describes how to remove WebDAV Services from a Windows host.

Caution: Make sure the Apache Tomcat application servers are stopped beforeremovingWebDAV Services. IBMWebSphere or BEAWebLogic application serversmust be running when removing WebDAV Services.

To remove WebDAV Services from a Windows host:

1. On the host machine, navigate to:• On Apache Tomcat: C:\Program Files\Apache Tomcat 5.5\webapps• On BEA WebLogic: bea/user_projects/ mydomain/applications• On IBM WebSphere: C:\Program

Files\WebSphere\AppServer\installedApps\<servername>

2. Delete the dmwebdav folder.

Removing WebDAV Services on UNIXThis section describes how to remove WebDAV Services from a UNIX host.


Removing WebDAV Services

Caution: Make sure the Apache Tomcat application servers are stopped beforeremovingWebDAV Services. IBMWebSphere or BEAWebLogic application serversmust be running when removing WebDAV Services.

To remove WebDAV Services using the delete option:

1. On the host machine, navigate to the directory called _uninst in the root location ofthe install (for example, $DOCUMENTUM_SHARED/_uninst).

2. Open the dmwebdav folder.

3. Open the appropriate application server folder (for example, TOMCAT55, BEA92,or WAS).

4. Select the dmwebdav folder.

5. Use the command rm –r to delete the folder.Alternatively, if you deployed WebDAV Services on WebLogic, you can remove theapplication from the admin console.

To remove WebDAV Services from BEA WebLogic:

1. Log in to the WebLogic Server admin console.

2. Click Lock + Edit.

3. Select Deployment.

4. Select dmwebdav and click Delete.On other application servers, WebDAV Services can be removed through the adminconsole by either deleting or undeploying the application.


Chapter 6Setting Up WebDAV Services Clients

This section describes how to set up and configure WebDAV‑enabled clients to work with a WebDAVServices repository. It contains the following sections:

• Configuring WebDAV clients, page 47• Configuring a Windows Web Folder for WebDAV Services, page 48• Configuring a Macintosh Web Folder for WebDAV Services, page 50

Configuring WebDAV clientsDocumentumWebDAV Services allows WebDAV‑enabled clients to access the repositoryso that users can perform authoring and versioning tasks on repository objects. Youcan access WebDAV Services through any client that supports the industry‑standardWebDAV protocol on either a Macintosh or Windows‑based machine. Microsoft Officeand Web Folders are all WebDAV‑enabled clients.

For example, the Windows Web Folders feature enables Windows Explorer to behave asa WebDAV client. By creating a Web Folder to point to a WebDAV server (for example,Documentum WebDAV Services), you enable Windows Explorer to view the repositoryexposed by the WebDAV server (in this case, the repository) as if it were a network drive.You can then perform a variety of tasks; for example, you can view repository contentsfrom the Web Folder, edit a document by double‑clicking it from the Web Folder, andsave the document back to the repository. The same is available on Macintosh clients.

For details about pointing a client to the Documentum WebDAV Services URL, see TheWebDAV Services URL, page 48.


Setting Up WebDAV Services Clients

The WebDAV Services URL

Typically, a WebDAV‑enabled client must be configured to point to a WebDAV Serverlocation using a URL. During configuration you are required to provide the name andweb address (URL) of Documentum WebDAV Services.

The WebDAV Services URL consists of the following components:

• host — The name or IP address of the host machine running the web server thatruns WebDAV Services.

• port — The port number at which the web server can be accessed.• servlet — The name of the WebDAV Services install (which runs as a Java servlet).• context — The application context in which WebDAV Services is running. The

context specifies which WebDAV properties are used. WebDAV Server provides adefault context named files to indicate that the default behavior of the server shouldbe used. Unless you are working within a custom application context, you shouldalways use the default context files.

The URL is structured as follows: http://<host>:<port>/dmwebdav/files. So, assuming thatthe WebDAV Server is running on the host machine warsaw at port 8080, and assumingthat the Java servlet is accessible at the path <dmwebdav>, the location of the WebDAVServer appears as http://warsaw:8080/dmwebdav/files.

If you wish to access a repository other than the default repository, you must specify therepository name in the URL following <files>. For example, if you want to access therepository named US_Global instead of your regular default repository, you wouldspecify the URL as: http://warsaw:8080/dmwebdav/files/US_Global:/.

If US_Global is your default repository, you do not need to include it in the URL.

Configuring a Windows Web Folder forWebDAV Services

This section provides instructions on how to create and configure a Windows WebFolder for a DocumentumWebDAV server. Web Folders allows for a secure environmentwhere you can upload, download, and manage files on a remote computer across anintranet or the Internet.

Using basic Windows features, you can create a Web Folder to point to a WebDAVServices server. This will allow you to view a list of repository contents in a WindowsExplorer window and allows applications (for example, Microsoft Office) to interactdirectly with a repository through the Save/Save As and Open dialog boxes.

For more information on Windows Web Folders, refer to the Windows Help system.



To create a Web Folder to point to WebDAV Services on Windows XP:

1. Go to Start >My Network Places and click Add a Network Place.The Add Network Place Wizard appears.

2. In the Add Network Place Wizard, follow the instructions to add a network place fora web site that supports Web Folders (WebDAV) and click Next.

3. Enter the WebDAV Server location and click Next. (The WebDAV Server URL hasthe structure http://<host>:<port>/dmwebdav/files/)The network password dialog box appears.

4. Enter your user name and password for the WebDAV Services repository and clickOK.

5. Enter a name to easily identify the repository and its location and click Next.

6. You will receive confirmation that the network place was created successfully. ClickFinish to close the Add Network Place Wizard.

7. If you have selected Open this network place when I click Finish, the repositorywill appear in a new Windows Explorer window.An icon for the repository network place will now appear in the My Network Placesfolder.

To create a Web Folder to point to WebDAV Services on Windows Vista:

1. Go to Start > Explore.

2. On the File menu, select Tools > Map Network Drive.The Map Network Drive Wizard opens.

3. Select Connect to a Web site that you can use to store your documents and pictures.The Add Network Location Wizard opens.

4. Select Choose a custom network location. Click Next.

5. Enter the WebDAV Server location and click Next. (The WebDAV Server URL hasthe structure http://<host>:<port>/dmwebdav/files/)The network password dialog box appears.

6. Enter your user name and password for the WebDAV Services repository and clickOK.

7. Enter a name to easily identify the repository and its location and click Next.

8. You will receive confirmation that the network place was created successfully. ClickConnect to close the Add Network Location Wizard.

9. If you have selected Open this network place when I click Connect, the repositorywill appear in a new Windows Explorer window.



An icon for the repository network place will now appear in the My Network Placesfolder.

Configuring a Macintosh Web Folder forWebDAV Services

This section provides instructions on how to create and configure a Macintosh WebFolder for a DocumentumWebDAV server. Web Folders allows for a secure environmentwhere you can upload, download, and manage files on a remote computer across anintranet or the Internet.

Using basic Macintosh features, you can create a Web Folder to point to a WebDAVServices server. This will allow you to view a list of repository contents in MacintoshFinder and allows applications to interact directly with a repository through theSave/Save As and Open dialog boxes.

For more information on Macintosh Web Folders, refer to the Macintosh Help system.

To create a WebFolder to point to WebDAV Services on Macintosh OS X:

1. Open a Finder window and click Go > Connect to Server.

2. The Connect To Server dialog box appears. Enter the WebDAV Server URL in theServer Address field and click Connect.

Note: You can also add the WebDAV Server URL to your Favorite Servers list andselect the URL from that location. This allows you to avoid entering the WebDAVServer URL each time you want to connect to the WebDAV Server.

3. The WebDAV File System Authentication dialog box appears. Enter your user nameand password in the appropriate fields and click OK.

4. The Finder Window displays the repository cabinets.



5. A Server Connection shortcut appears on your desktop.


Chapter 7WebDAV Services Configuration

This chapter contains information on configuring WebDAV Services. Note that any necessaryconfiguration is completed during the deployment. The following additional configuration tasks areavailable to perform after deployment:

• Configuring the servlet, page 53• Activating logging, page 54• Accessing other repositories, page 55• Creating configurable object types on import, page 55• Configuring for SAP XML client integration, page 57

Configuring the servletConfiguration details for WebDAV Services are contained in the servletweb.xml file,which is located in the Web‑INF directory of the web application. When WebDAVServices is installed, a default web application is created (dmwebdav), which containsthe web.xml file. If necessary, you can modify the web.xml file according to yourorganization’s specific requirements. To review a sample web.xml file, refer to AppendixA, Sample servlet web.xml file.

This section lists configurable parameters in web.xml in addition to the tasks describedin Configuring the web.xml file, page 34.

You can configure the following parameters in the web.xml file:

• session‑timeout — This value indicates the time‑out period in minutes for which theserver‑side session is maintained in absence of a request from the same client. If norequests are received by the server for the specified period, subsequent requestsfrom the client require re‑authentication to re‑establish a session.

• grace‑period — The time (in seconds) the lock cleanup thread waits beyond thelock_expiration_date before cleaning up the webdav_lock object. The default valueis 0 seconds.


WebDAV Services Configuration

• max‑requests‑per‑daemon — The maximum number of cleanup requests that canbe handled by a cleanup job. If the maximum number is reached, a new cleanupjob will be created.

• max‑requests‑per‑queue — The maximum number of cleanup requests that can behandled by a queue. If a queue reaches the maximum number of requests, a newcleanup queue will be created.

• cleanup‑idletime — The amount of time the cleanup daemon will sleep beforere‑scanning the cleanup list for any timed‑out locks.

• depth‑limit — The maximum number of levels WebDAV Server retrieves folderhierarchy information in response to PROPFIND and other methods, which usuallyspecify a depth parameter in the request header. The default value is set to 1 toensure optimum server performance.

• special‑prefixes — A comma‑separated list of special prefixes to be handled by theWebDAV Server. Each special prefix has a corresponding entry as the <param‑name>and has the ContextHook implementation as its value.

• max‑number‑of‑search‑results — This is the maximum number of search results thatwill be returned for a given DQL query that involves finding documents in therepository. Searches are submitted using the WebDAV SEARCH method. If thisvalue is set to ʺ‑1ʺ, all results are returned. Any positive integer can be used as themaximum number that will be returned. The default value is 100 results.

• dfc‑trace — This value specifies whether or not DFC tracing is turned on. To turn ontracing, the value must be set to 1. By default, the value is set to 0. One DFC tracefile is created per server in the <install_location>\log directory. The name of theDFC trace file is dfc‑trace.txt.

Activating loggingWebDAV Services uses the log4j logging facility provided by Documentum FoundationClasses. You can modify the log4j.properties within the C:\Documentum\Configdirectory on Windows, or /local/documentum/config on UNIX.

The default log level is set to ERROR. You can change the log level to DEBUG toget more logging information. You can also add various appenders to display thelogging information. Refer to the Apache Tomcat log4j Project documentation(http://jakarta.apache.org/log4j/docs/documentation.html) for more details.

One log file is generated by log4j per authenticated user in the <Documentum_User_Dir>/WebDAV_Services/logs directory. The file name has the format<ip_address>‑<time_of_first_request>.txt.

There is also a log file generated when the server starts, which stores configurationvalues being used. The file name has the format webdav_<time_of_first_request>.txt.


http://jakarta.apache.org/log4j/docs/documentation.html

http://jakarta.apache.org/log4j/docs/documentation.html


Accessing other repositoriesYou may want to access repositories across multiple Connection Brokers.

To access other repositories:

1. Modify your dfc.properties file (located in C:\WINNT on Windows and$DOCUMENTUM/ on UNIX) to add additional docbroker entries with theConnection Brokers you want to contact to get a list of repositories. The primarydocbroker entry is dfc.docbroker.host[0]; you can add backup hosts by incrementingthe index number within brackets.dfc.docbroker.host[1]=my docbroker backup 1dfc.docbroker.port[1]=1489dfc.docbroker.host[2]=my docbroker backup 2dfc.docbroker.port[2]=1489dfc.docbroker.host[3]=my docbroker backup 3dfc.docbroker.port[3]=1489

You can also change your primary docbroker to be the name of the ConnectionBroker you want to access as follows:dfc.docbroker.host[0]=my docbroker primarydfc.docbroker.port[0]=1489

Creating configurable object types on importWebDAV Services gives you the ability to configure object types that are available onimport. The available document object type and folder object type are configurable inthe web.xml configuration file.

The values identified in bold below can be added to the web.xml configuration file, toconfigure the object type and folder type upon file import.<initparam>

<paramname>documentObjectType_repositoryname</paramname><paramvalue>documentObjectType</paramvalue><description>The repository object type that will be used while creating

new objects.</description>

</initparam><initparam>

<paramname>folderObjectType_repositoryname</paramname><paramvalue>folderObjectType</paramvalue><description>The repository object type that will be used while creating


</initparam>



For example, for a repository named EastCoast, if the documentObjectType is webdav andfolderObjectType is webdav_folder, the web.xml entry will be as follows:<initparam>

<paramname>documentObjectType_EastCoast</paramname><paramvalue>webdav</paramvalue><description>The repository object type that will be used while creating


</initparam><initparam>

<paramname>folderObjectType_EastCoast</paramname><paramvalue>webdav_folder</paramvalue><description>The repository object type that will be used while creating


</initparam>

The following are some rules when configuring WebDAV Services for object types:• documentObjectType must be a subtype of dm_sysobject, and folderObjectType

must be a subtype of dm_folder.• If you want to configure multiple repositories, the corresponding entries must be

added to web.xml for each repository.• If the entries are missing for a particular repository in the web.xml configuration file,

the default values of dm_document and dm_folder will be applied.• If a non‑valid object type is added to the web.xml configuration file, WebDAV

Services will not work properly against that repository.

To configure WebDAV Services for configurable object types:

1. Stop the WebDAV Server.

2. Locate the web.xml file. Its location depends on which operating system andapplication server your WebDAV Server is using:• Apache Tomcat — $CATALINA_HOME/webapps/dmwebdav/WEB‑INF• BEA WebLogic has two web.xml files:

— $BEA_HOME/user_projects/domains/<domain_name>/myserver/upload/dmwebdav/dmwebdav/WEB‑INF

— $BEA_HOME/user_projects/domains/<domain_name>/myserver/.wlnotdelete/extract/myserver_dmwebdav_dmwebdav/jarfiles/WEB‑INF/lib

• IBM WebSphere — $WAS_HOME/installedApps/<server_name>/dmwebdav.ear/dmwebdav.war/WEB‑INF


4. Add as many documentObjectType and folderObjectType entries as needed.




6. Restart the WebDAV Server.

Configuring for SAP XML client integrationIn order to certify the SAP XML client for Data Archiving Services against WebDAVServices, it is necessary to configure the WebDAV Services web.xml file. This involvesuncommenting a section of the configuration file, allowing the client to receive an errorvalue of 200 (instead of the standard 403) for collection objects against a HEAD/GETmethod.

To configure WebDAV Services for SAP XML client integration:

1. Stop the WebDAV Server.

2. Locate the web.xml file. Its location depends on which operating system andapplication server your WebDAV Server is using:• Apache Tomcat — $CATALINA_HOME/webapps/dmwebdav/WEB‑INF• BEA WebLogic has two web.xml files:

— $BEA_HOME/user_projects/domains/<domain_name>/myserver/upload/dmwebdav/dmwebdav/WEB‑INF

— $BEA_HOME/user_projects/domains/<domain_name>/myserver/.wlnotdelete/extract/myserver_dmwebdav_dmwebdav/jarfiles/WEB‑INF/lib

• IBM WebSphere — $WAS_HOME/installedApps/<server_name>/dmwebdav.ear/dmwebdav.war/WEB‑INF


4. Uncomment the following section in the web.xml file:<initparam>

<paramname>return200ForCollection</paramname><paramvalue>yes</paramvalue><description>This is to enable new certification

for SAP Client, this returns 200 instead of 403 forcollection objects for a HEAD/GET method.

</description></initparam>




6. Restart the WebDAV Server.


Chapter 8WebDAV Services Administrator

This chapter contains information on how to use the web‑based WebDAV Services Administratorutility to monitor the various configuration settings, sessions, and locks for a given WebDAV Servicesdeployment. This chapter contains the following sections:

• Using the WebDAV Services Administrator, page 59• Logging in, page 60• Listing allocated WebDAV sessions, page 61• Viewing repository attributes, page 62• Cleaning up WebDAV orphan locks, page 63• Listing scheduled Lock Cleanup jobs, page 64• Displaying WebDAV Server configuration, page 64• Changing the Administrator password, page 66• Logging out, page 67

Using the WebDAV Services AdministratorThe WebDAV Services Administrator enables you to administer an instance of WebDAVServices through your web browser. You can use the Administrator to perform a varietyof tasks, such as viewing WebDAV sessions, viewing available repositories, cleaning uplocks, viewing lock clean‑up jobs, displaying WebDAV Services configuration details,and changing the system administrator password. The Administrator has an easy‑to‑useinterface, which consists of two main panes: the left pane, which contains the menu bar;and the main pane, which contains the display area.


WebDAV Services Administrator

The WebDAV Services WAR file automatically installs the Administrator and sets upa default system administrator user account. You can only log in to the utility usingthis user account.

The WebDAV Administration utility makes use of session cookies and javascript. Beforeyou log in, you should make sure these options are enabled in your browser settings andin your firewall software settings. If your firewall blocks the execution of javascript,the Administrator will not work.

Logging inThe WebDAV Services WAR file automatically sets up one default system administratoruser account. Once the deployment is complete and WebDAV Services is running, youcan log in to the Administrator using the default system administrator user name andpassword. The default user name is admin; the default password is also admin.

To log in to the utility, you must first launch your web browser and specify theweb address (URL) for the WebDAV Services Administrator. The structure ofthe URL is http://<host>:<port>/dmwebdav/main.jsp, as shown in the example:http://warsaw:8080/dmwebdav/main.jsp.

To log in to the administration utility:

1. Open your web browser.



2. In the web address field, enter the web address (URL) for the administration utilityand click Enter.The WebDAV Services Administrator login screen appears.

3. In the Login Name field, enter the default administrator user name, admin.

4. In the Password field, enter the administrator user password. If this is your first timelogging in, enter the default password, admin.

Note: Once you have successfully logged in for the first time, you can change thedefault password. For information, see Changing the Administrator password,page 66.

5. Click Login.The Administrator opens and displays a list of available repositories that can beaccessed through the WebDAV Server.

Listing allocated WebDAV sessionsUsing the Administrator, you can view a list of all allocated WebDAV sessions. Whenyou perform this task, the Administrator queries the WebDAV session manager to seehow many clients are currently logged in and displays the following information foreach session:

• User name — the user’s login name• Repository name — the name of the repository to which the user is logged in



• Repository ID — the ID of the repository• First request time — the date and time of the first request by the user• Last request time — the date and time of the last request by the user• Number of requests — the number of requests made

To view allocated WebDAV sessions:

1. In the menu bar, clickWebDAV Sessions.The Administrator displays a list of allocated WebDAV sessions, along with detailsfor each session.

Viewing repository attributesUsing the Administrator, you can view a list of all of the repositories that are availableto the WebDAV Server. When you perform this task, the Administrator accesses theConnection Broker through the DMCL and lists the available repositories. You canthen log in to any of the available repositories to view repository attributes. Repositoryattributes include, but are not limited to, the following:• Repository name — the name of the repository• Description — a description of the repository• Creation date — creation date of the repository• Modify date — date the repository was last modified• Full text supported — indicates whether or not full indexing search is enabled



• Richmedia enabled — indicates if Documentum Media Transformation Services isinstalled

To log in to a repository and view its attributes, you must have a login account (username and password) for the selected repository. If you have any questions about yourrepository access, see your repository administrator.

To view repository attributes:

1. In the menu bar, click Available Repositories.The Administrator displays a list of available repositories.

2. To view a repository’s attributes, click the link for the repository.The Administrator displays a login screen for the selected repository.

3. Enter a valid user name and password for the repository, and click Login.The Administrator displays the repository attributes.

If the Administrator does not display the repository attributes, check with yourrepository administrator to make sure you are using the correct user name and passwordfor the selected repository.

Cleaning up WebDAV orphan locksWhen WebDAV Services creates a webdav_lock object that has a specified time‑outperiod, WebDAV Services schedules a lock cleanup activity to occur after the time‑out



period (if a lock refresh or unlock has not been requested). If you don’t want to wait for acleanup job to occur, you can also manually initiate a lock cleanup activity to clean uplocks that have passed their time‑out period (orphan locks) using the Administrator.

To clean up WebDAV orphan locks:

1. In the menu bar, click Orphan Locks Cleanup.

2. Select a repository for cleanup. Log into the repository.The Administrator cleans up all orphan locks and notifies you on completion.

Listing scheduled Lock Cleanup jobsYou can use the Administrator to list all lock cleanup jobs currently scheduled to occur.Viewing scheduled cleanup jobs gives you an idea of how many documents are beingworked on at a given time. For each lock cleanup job, the Administrator displays thefollowing information:

• ID• Lock owner• Repository name (where lock was made)• Creation date• Expiration date

To view all scheduled lock cleanup jobs:

1. In the menu bar, click Lock Cleanup Jobs.The Administrator displays a list of all scheduled lock cleanup jobs.

Displaying WebDAV Server configurationYou can use the Administrator to view configuration details for WebDAV Services. TheAdministrator displays configuration details in read‑only format. If you wish to makechanges to the settings, you can do so by modifying the web.xml configuration file. Fordetails, see Configuring the servlet, page 53.

The Administrator displays the following WebDAV Server configuration details:• Repository‑name — The default repository name. If a user does not specify a

repository in the WebDAV Services URL, WebDAV Services connects to thisrepository.

• Default‑port — The default port that the application server is running on.



• Session‑timeout — This value indicates the time‑out period in minutes for which theserver‑side session is maintained in absence of a request from the same client.

• Depth‑limit — The maximum number of levels deep WebDAV Services retrievesfolder hierarchy information in response to PROPFIND and other methods. Thedefault value is 1 to ensure optimum server performance.

• Grace‑period — The time (in seconds) the lock cleanup thread waits beyond thelock_expiration_date before cleaning up the webdav_lock object.

• Cleanups‑per‑queue — The maximum number of cleanup requests that can behandled by a queue. If a queue reaches the maximum number of requests, a newcleanup queue will be created.

• Cleanups‑per‑daemon — The maximum number of cleanups that can be handled bya cleanup job. If the maximum number is reached, a new cleanup job will be created.

• Cleanup‑idletime — The amount of time the cleanup daemon will sleep beforere‑scanning the cleanup list for any timed‑out locks.

• Max‑number‑of‑search‑results — The maximum number of search results that will bereturned for a given DQL query that involves finding documents in the repository.

• Application name — The name of the applications (servlets) running.

To display the WebDAV Server configuration:

1. In the menu bar, clickWebDAV Services Config.The Administrator displays a list of configuration details for WebDAV Services.



Changing the Administrator passwordTo enable you to log in to the Administrator for the first time, the WebDAV ServicesWAR file sets up a default system administrator user name and password. Once youhave successfully logged in to the Administrator, you can change the default passwordto a new password of your choice.

To change the Administrator password:

1. In the menu bar, click Change Password.The Administrator displays the Change Password screen.

2. In the Old Password field, enter the current administrator password.If this is your first time using the Administrator, this will be the system‑defineddefault password, which is located in the password file (webdav.admin) as specifiedin the webdav_admin.xml file.

3. In the New Password field, enter a new password of your choice.The password field is case sensitive and can contain any combination of lettersand/or numbers.

4. In the Confirm Password field, enter the new password again.

5. Click Change.The system saves the new password to the system password file. The next time youlog in to the Administrator, you must use your new password.

If you need to change the name of the admin user, first contact your repositoryadministrator to have the user name changed in the repository. You can then update thewebdav_admin.xml file with the new user name.



Logging outWhen you are finished using the WebDAV Services Administrator, you can end yourcurrent session by logging out.

To log out of the Administrator:

1. In the menu bar, click Logout.The Administrator closes.


Chapter 9Troubleshooting

This chapter contains troubleshooting or error resolution information relating to WebDAVdeployment, configuration, and administration.

This chapter contains troubleshooting information for the following problems:

• Cannot connect to WebDAV Services, page 69• Authentication never occurs, page 70• Error creating temp file exception occurs (Tomcat), page 70• Running out of sessions, page 71• Cannot copy or paste cabinets, page 71• Errors related to incorrect port numbers, page 72

Cannot connect to WebDAV ServicesIf you cannot connect to WebDAV Services, perform the following troubleshootingactions to determine the cause.

1. Make sure the Content Server you are connected to is running.You can use Documentum Administrator to verify connectivity with a givenrepository. If you are not sure how to do this, contact your Content Serveradministrator.

2. Make sure your application server is running.If you are running Apache Tomcat as a Windows service, make sure the ApacheTomcat service has a status of Started in the Services administrative tool (andlikewise for BEA WebLogic). If you’re running Tomcat or WebLogic as a batch file,make sure the process is running correctly in the Windows Task Manager underthe Processes tab.

3. Make sure you are connecting to the port that your application server is running on.


Troubleshooting

The default port is 8080 for Tomcat, 7001 for WebLogic, and 9080 for WebSphere;these should not change unless you had the application server installed previouslyand the port number was modified.

4. Make sure your URL to WebDAV Services is well formed. The format is:http://<host>:<port>/dmwebdav/files/<repository_name:>/An example of a well‑formed URL is: http://warsaw:8080/dmwebdav/files/my_repository:/The WebDAV Services servlet name should always be dmwebdav unless youmodified the web.xml file to change this. The context should always be files unlessthe web.xml file is modified to reflect this.

5. Make sure you have a valid user ID and password for the repository to which youare trying to connect.If you are unsure of your repository login, contact your Content Server administrator.

6. If you are trying to connect to the default repository by using a URL as follows,http://<server_name>:<port_number>/dmwebdav/files/In the web.xml file make sure that the repository parameter values are set to validvalues and ensure the repository to which you want to connect is running.

7. Try connecting to WebDAV Services using the IP address of the machine instead ofthe machine name.If this works, contact your network administrator to make sure the IP address of themachine running WebDAV Services is resolving properly on the network.

Authentication never occursIf authentication never occurs when connecting to a repository using WebDAV Services,check your web.xml file to make sure the auth‑type parameter is set to basic. If it is set toanonymous, the anonymous‑user, anonymous‑password, and anonymous‑domain mustbe set to the user name, password, and domain of a valid repository user. Otherwise,you will not be able to connect to the repository.

Error creating temp file exception occurs(Tomcat)

If you are running Apache Tomcat and an error creating temp file exception occurs,perform the following troubleshooting actions to determine the cause:


Troubleshooting

1. Make sure there is storage space available on the device where you are runningyour Content Server.

2. If you are using a Tomcat application server, make sure the catalina.bat file inTomcat’s /bin directory is referring to a valid directory. The default entry forWindows is:if not ʺ%CATALINA_TMPDIR%ʺ == ʺʺ goto gotTmpdir set CATALINA_TMPDIR=%CATALINA_BASE%\temp :gotTmpdirThe default entry for UNIX:if [‑z ʺ$CATALINA_TMPDIRʺ; then CATALINA_TMPDIR=”$CATALINA_BASE”/temp :gotTmpdirThis means that a directory called tempmust be present in your Tomcat folder. If thisdirectory does not exist, you must create it. You must also ensure that Tomcat canwrite to this directory.

Running out of sessionsWhen the DMCL has allocated the maximum number of sessions that can be createdfrom one process, the following error appears in the Tomcat, WebLogic, or WebSphereoutput window or log file:[DM_API_E_NO_SESSION]error; "There are no more available sessions"

To fix this error, you can increase the number of sessions.

To increase the number of sessions:

1. Modify the dfc.properties file in your application server machine, usually locatedin C:\Windows or $DOCUMENTUM, to increase the number of client sessionsthat can be allocated from one process. The following line must be added to thedfc.properties file:max_session_count = 100This will increase the number of sessions to 100. You can change this to a value thatsuits the deployment of your Content Server.

Cannot copy or paste cabinetsCopying and pasting of cabinets is not permitted in WebDAV Services. For moreinformation, see theWebDAV Services Release Notes.


Troubleshooting

Errors related to incorrect port numbersEnsure that the port number specified during WebDAV deployment agrees with that ofthe application server. This requirement pertains to both secure (SSL) and regular portdesignations. Otherwise, these types of errors might occur:

• An extra cabinet bearing the name of the repository (<repository>:) appears, inaddition to the valid cabinet named <repository>. Double‑clicking the <repository>:cabinet produces an error message.

• When the user double‑clicks a cabinet in Web Folders, they receive an errorindicating that the folder name is invalid. Also, the URL displayed in the addressbar includes an incorrect port number.


Appendix A

Sample servlet web.xml file

The servlet web.xml file can be configured if required. See Configuring the servlet, page 53 forinformation about parameters that can be configured in this file.<?xml version='1.0' encoding='ISO88591'?><!DOCTYPE webapp PUBLIC "//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/webapp_2_3.dtd" ><webapp><displayname>Documentum WebDAV Server</displayname><! Definition and configuration of servlet filters ><filter><filtername>webdavlog</filtername><filterclass>com.emc.documentum.webdav.filter.DwLogFilter</filterclass></filter><filtermapping><filtername>webdavlog</filtername><servletname>dmwebdav</servletname></filtermapping><servlet><servletname>dmwebdav</servletname><displayname>Documentum WebDAV Services</displayname><servletclass>com.emc.documentum.webdav.servlet.DwWebDAVServlet</servletclass><initparam><paramname>docbase</paramname><paramvalue>default_docbase</paramvalue><description>Name of the docbase to be made accessible through Documentum WebDAV Services</description></initparam><initparam><paramname>authtype</paramname><paramvalue>BASIC</paramvalue><description>The Authentication mechanism used to authorize users. The only valid values at

this time are BASIC and ANONYMOUS. When ANONYMOUS is the authtype, the parametersanonymous_user, anonymous_password, and anonymous_domain will also have to bespecified. The default value is BASIC.

</description></initparam><initparam><paramname>anonymoususer</paramname><paramvalue>docbase_username</paramvalue>



<description>The User Name to be used to connect to the docbase. This will only be used

when authtype is set to ANONYMOUS.</description></initparam><initparam><paramname>anonymouspassword</paramname><paramvalue>docbase_password</paramvalue><description>The password to be used to connect to the docbase. This will only be used

when authtype is set to ANONYMOUS.</description></initparam><initparam><paramname>anonymousdomain</paramname><paramvalue/><description>The NT Domain to be used to connect to the docbase. This will only be used when

authtype is set to ANONYMOUS.</description></initparam><initparam><paramname>sessiontimeout</paramname><paramvalue>30</paramvalue><description>This initparameter determines the session timeout period in minutes. If a

particular WebDAV Session has been inactive for more than the specified number ofminutes, the session would timeout and the user would be prompted to Login againwhen accessing Documentum WebDAV Services.

</description></initparam><initparam><paramname>graceperiod</paramname><paramvalue>1x</paramvalue><description>The grace period in seconds the lock cleanup thread should wait beyond the

lock_expiration_date before cleaning up the webdav_lock object. The default value is0 seconds.

</description></initparam>

<initparam><paramname>docbaseroot</paramname><paramvalue>/wallstreet/AGS_Test/</paramvalue><description>The cabinet or the cabinet/folder path to be exposed by Documentum WebDAVServices. For example, if the docbaseroot is specified to be /Website, onlythe document folders within the /Website cabinet will be exposed to theWebDAV client. A request of the format/contextpath/servletpath/ will bemapped to /Website/. The default value is "/" that means the completeDocbase is exposed.</description></initparam>

<initparam><paramname>depthlimit</paramname><paramvalue>3</paramvalue>



<description>This initparameter determines the depth limit for PROPFIND and other methods,

to avoid performance hits on the server for requests with infinite depth. Thedefault value is '1'.

</description></initparam><initparam><paramname>maxnumberofsearchresults</paramname><paramvalue>20</paramvalue><description>This initparameter determines the maximum number of search results that will be

returned for a given SEARCH query. If this value is "1", all results are returned.</description></initparam><initparam><paramname>specialprefixes</paramname><paramvalue>/files/,/wcm/</paramvalue><description></description></initparam><initparam><paramname>/files/</paramname><paramvalue>com.emc.documentum.webdav.applications.DwContextHook</paramvalue><description></description></initparam><initparam><paramname>/wcm/</paramname><paramvalue>com.emc.documentum.webdav.applications.DwContextHook</paramvalue><description></description></initparam><initparam><paramname>defaultservlet</paramname><paramvalue>true</paramvalue><description>By default, Documentum WebDAV Services is mapped as the default servlet of the web

application context (the urlpattern in servletmapping is '/'). If you want tochange that mapping so the servlet is no longer the default servlet, you mustchange this initialization parameter to indicate the situation to the servlet,by setting it to 'false'. The default value is 'true'.

</description></initparam><initparam><paramname>defaultport</paramname><paramvalue>8080</paramvalue><description>The port of the servlet.

The default port for Apache Tomcat is '8080'.The default port for BEA WebLogic is '7001'.The default port for IBM WebSphere Application Server is '80'.

</description></initparam><initparam><paramname>dmcltrace</paramname><paramvalue>0</paramvalue><description>



If this value is set to '1', DMCL tracing is enabled</description></initparam><initparam><paramname>dfctrace</paramname><paramvalue>0</paramvalue><description>If this value is set to '1', DFC tracing is enabled</description></initparam>

<! <initparam><paramname>documentObjectType_docbasename</paramname><paramvalue>webdav</paramvalue><description>The docbase object type that will be used while creating new objects.</description></initparam><initparam><paramname>folderObjectType_docbasename</paramname><paramvalue>webdav_folder</paramvalue><description>The docbase object type that will be used while creating new objects.</description></initparam> ><initparam><paramname>return200ForCollection</paramname><paramvalue>yes</paramvalue><description>This is to enable new certification for SAP Client, this returns 200instead of 403 for collection objects for a HEAD/GET method.</description></initparam><loadonstartup>1</loadonstartup></servlet>

<! Servlet to get Docbase map ><servlet><servletname>service</servletname><servletclass>com.emc.documentum.webdav.servlet.DwInitServlet</servletclass></servlet>

<! The mapping for Documentum WebDAV Services.If you change the mapping so that Documentum WebDAV Services

isn't the default servlet anymore, make sure to set theinitparameter 'defaultservlet' to 'false'. >

<servletmapping><servletname>dmwebdav</servletname><urlpattern>/files/*</urlpattern></servletmapping>

<servletmapping><servletname>dmwebdav</servletname><urlpattern>/wcm/*</urlpattern></servletmapping>



<! added for Docbase map ><servletmapping><servletname>service</servletname><urlpattern>/service</urlpattern></servletmapping>

</webapp>


Index

Aactivating logging, 54Anonymous authentication, 34Anonymous user

configuration, 34domain, 34password, 34

Apache Tomcaterror creating temp file exception, 70log4j logging facility, 54running out of sessions, 71starting/stopping

on UNIX, 43on Windows, 42

application serversstarting on UNIX, 43starting on Windows, 42stopping on UNIX, 43stopping on Windows, 42

authenticationBasic on WebLogic, 41mechanism, 34troubleshooting, 70

BBasic authentication

on WebLogic/Mac, 41BEA WebLogic

configuring, 41running out of sessions, 71starting/stopping


BEA_HOME environment variable, 27

CCATALINA_HOME environment

variable, 27

cleanup jobs, description of, 16cleanup requests

idle time, 54maximum number per daemon, 54maximum number per queue, 54

client applicationsdescription of, 9Macintosh Web Folders, 50Windows Web Folders, 48

clientspointing to WebDAV Services, 48setting up, 47

clustering, 36config.xml file, configuring, 41configuration details, 64configuring

config.xml file, 41log4j.properties file, 35web.xml, 34WebDAV clients, 47WebDAV servlet, 53

anonymous‑domain, 34anonymous‑password, 34anonymous‑user, 34authorization type, 34cleanup idle time, 54default port, 34default repository, 34depth limit, 54DFC trace, 54grace period, 53maximum number of search

results, 54maximum requests per job, 54maximum requests per queue, 54session time‑out, 53special prefixes, 54

connection brokers, 32connectivity issues, troubleshooting, 69


Index

Ddaemon, 54DAR, installing, 36DAV_Lock_Cleanup

installing job support files, 39default port, 34default repository, 34deploying WebDAV Services, 31

predeployment requirements forUNIX, 24

predeployment requirements forWindows, 21

software requirements for UNIX, 24software requirements for

Windows, 21verifying deployment, 44

deployment, 10deployment files

UNIX permissions, 25depth limit, 54DFC

global registry, 32requirement for WebDAV on

UNIX, 28requirement for WebDAV on

Windows, 23trace, 54

DFC_DATA environment variable, 26dfc.properties, 32

connection broker, 32DOCUMENTUM environment

variable, 25Documentum Foundation Classes, see

DFCDOCUMENTUM_SHARED environment

variable, 26

Eenvironment variables

library path, 26UNIX, 25

errors, see troubleshootingexpired locks, 63

Gglobal registry, 32grace period, 53

IIBM WebSphere

starting/stoppingon UNIX, 44on Windows, 43

troubleshooting, 71installing

WebDAV DAR, 36WebDAV Source, 39

JJAVA_HOME environment variable, 26

LLD_LIBRARY_PATH environment

variable, 26LIBPATH environment variable, 26lock cleanup jobs

description of, 16listing, 64

locks, 15log file locations, configuring, 35log4j logging facility, 54log4j.properties file, configuring, 35logging in to repository

domain, 36logging, activating, 54

MMacBinary, 18Macintosh

resource forksdescription of, 16preserving, 18

type and creator codes, 17maximum number of search results, 54MS update for Web Folders, 41MS Vista, update for WebFolders, 41

Oorphan locks

cleaning up, 63description of, 16

Ppassword, changing, 66


Index

permissions, 25port number errors, 72predeployment requirements

UNIX, 24checklist, 27software, 24

Windows, 21checklist, 22software, 21

prefixes, special, 54privileges, 36

Rremoving

from UNIX, 45from Windows, 45

repositoriesaccessing, 55setting default, 34

request methods, 11, 13resource forks, 16

preserving with MacBinary, 18

Sscheduled lock cleanup jobs, listing of, 64search results, configuring, 54secure ports, 72servlet

configuring, 53See also configuring WebDAV

servletsample file, 73

session time‑out, 53sessions, increasing, 71setting up WebDAV clients, 47software requirements

UNIX, 24Windows, 21

special prefixes, 54SSL ports, 72starting application servers


starting Composer, 36stopping application servers


superuser privilege, 36

Ttemp file exception error, 70terminology, 11Tomcat, see Apache Tomcattroubleshooting, 69 to 72

Apache Tomcat, 70 to 71authentication, 70BEA WebLogic, 71connectivity, 69copy/paste cabinets, 71IBM WebSphere, 71number of sessions, 71port numbers, 72

UUniversal Resource Identifier, see URIUNIX

environment variables, 25predeployment requirements, 24removing WebDAV Services, 45starting/stopping app servers, 43

URIdefinition of, 12HTTP and WebDAV methods, 13

URL for WebDAV, 48, 50user name, changing, 66using WebDAV Services

Administrator, 59

VVista, see MS Vista

WWAR file

deploying, 35unpack, 31

WAS_HOME environment variable, 27web address for WebDAV, 48, 50Web Folders

configuring on Macintosh, 50configuring on Windows, 48

web.xml fileconfiguring, 34, 53, 55, 57, 64sample, 73

WebDAVcommunication sequence, 12definition, 9


Index

lock cleanups, 16locks, 15methods, 13protocol, 9request, definition of, 12resource, definition of, 12response, definition of, 12terminology, 11

WebDAV clientsconfiguring, 47definition of, 12Macintosh Web Folders, 50setting up, 47Windows Web Folders, 48

WebDAV Serverdefinition of, 12displaying configuration, 64

WebDAV Servicesauthenticating, 70connectivity issues, 69deploying, 31deployment, 10

description of, 10pointing clients to, 48

WebDAV Services Administratorchanging the password, 66cleaning up orphan locks, 63displaying WebDAV Server

configuration, 64listing scheduled lock cleanup jobs, 64listing WebDAV Sessions, 61logging in, 60logging out, 67using, 59viewing repository attributes, 62

WebDAV Source, installing, 39webdav_lock object type, 16WebLogic, see BEA WebLogicWebSphere, see IBM WebSphereWindows

predeployment requirements, 21removing WebDAV Services, 45starting/stopping app servers, 42


WebDav Documentum 6.5

Documents

Transcript of WebDav Documentum 6.5