Use WebDAV in CM ENTERPRISE PORTAL 5.0. ASAP How to Paper

Transcription

1 How to Use WebDAV in CM ENTERPRISE PORTAL 5.0 ASAP How to Paper Applicable Releases: EP 5.0 SP3, SP4 August 2002

2 HOW TO... 1 USE WEBDAV IN CM BUSINESS SCENARIO THE RESULT THE STEP BY STEP SOLUTION Prerequisites Scenario 1: Carrying Out Mass Operations Settings with WINDOWS Carrying Out File Operations Using the Web Folder Scenario 2: Including Another WebDAV Server as a Repository Settings in the KM Platform of the Enterprise Portal Configuration of the WebDAV Protocol Enhancing the KM System Landscape Modifying Credentials Enhancing the Portal System Landscape Creating a Cache Creating and Configuring a WebDAV Repository Manager Enhancing Personal Settings (User Mapping Scenario) Creating and Configuring an Index Assigning Indexes to the WebDAV Repository Activating Subscription Event Mapping for the Repository APPENDIX Troubleshooting COPYRIGHT SAP 1

3 1 Business Scenario Documents in your enterprise are stored on WebDAV servers. You want to use the Knowledge Management (KM) platform to make these documents accessible by employees in the Enterprise Portal. Employees need to read and edit these documents. They also need to create new documents. You also want to make the most of subscription and collaboration services, and to be able to search for documents. Users of the Portal can also take advantage of WebDAV. WebDAV enables documents to be edited directly on the server. You can use a WebDAV-capable client (for example, Microsoft Office 2000) to open the file directly from the Portal server. You can then make your changes. When you save, the document is updated directly on the Portal server and can be called up in the Portal in its newest version. Locking and version control mechanisms ensure secure work within groups and prevent documents from being accidentally overwritten. The Knowledge Management platform can be implemented as a WebDAV server and as a WebDAV client. This allows it to be used in different scenarios. The KM platform as a WebDAV server You want to access CM repositories of the KM platform with a WebDAV-capable client, for example, MS Webfolder. We recommend this especially if you want to transfer large numbers of files to the KM platform (mass operations). The KM platform as a WebDAV client You want to use the KM platform to access documents that are stored on other WebDAVcapable servers (for example, in another Enterprise Portal or on Microsoft Internet Information Servers). You need a WebDAV repository manager to do this. 2 The Result This how-to guide describes the steps required in order to transfer a large number of documents to the Portal using WebDAV, and to include a WebDAV server as a repository in the KM platform of the Enterprise Portal. If you carry out the work steps described, you will be able to access documents stored on a WebDAV-capable server with read or write access using the Portal. This makes services such as search, subscription, and collaboration available to you SAP 2

4 3 The Step By Step Solution 3.1 Prerequisites Note that not every WebDAV-capable server supports all offered functions. Therefore, you should first check whether the technical prerequisites meet your demands. For example, not every WebDAV server supports version management using DeltaV. A Selection of WebDAV Servers and Supported Functions EP with CM- Repository Apache moddav MS IIS 5.0 RFC 2518 XML Properties (Except attributes) Partly (nested namespaces) Collection Locks Deep Locks No Sorted Collections Redirect Links External No No No No No No No No Version Management (DeltaV) The following WebDAV-capable clients allow you to access documents stored in the KM platform directly. Adobe GoLive 5 Macromedia Dreamweaver Microsoft Windows 2000 Microsoft Office 2000 Microsoft Internet Explorer 5 And many more Scenario 1: Carrying Out Mass Operations At the moment it is arduous to transfer large numbers of documents to the KM platform in order to be able to make the most of the advantages of Knowledge Management. The documents must be uploaded individually to the KM platform using the Upload function. WebDAV facilitates the integration of a large number of documents into the KM platform SAP 3

5 3.2.1 Settings with WINDOWS 2000 If you want to carry out mass operations or to use the KM platform as a WebDAV server and access it with a WebDAV client, you need to create a Web folder. You do this as follows: 1. In Windows Explorer, go to My Network Places. 2. Choose Add Network Place. 3. Enter the URL of the WebDAV server (for example: and a name for this Web folder. Result: A new Web folder (recognizable by this icon: ) is displayed Carrying Out File Operations Using the Web Folder This Web folder gives you access to documents and folders that are stored on your WebDAV server (the KM platform). You can copy large numbers of documents to the WebDAV server or delete a selection of documents at once. Services such as subscriptions are still supported even if you integrate documents into the Portal in this way. However, you can only assign user-defined properties to resources from the Portal. A WebDAV-capable client (see under 3.1) allows you to open, edit, and save files directly from the Web folder. Advantage: You can work more quickly as you no longer need to download and upload the documents. 3.3 Scenario 2: Including Another WebDAV Server as a Repository Settings in the KM Platform of the Enterprise Portal 5.0 Call up the Enterprise Portal and log on. You must be assigned to the KM admin role Configuration of the WebDAV Protocol The WebDAV protocol used by the KM platform is already preconfigured. You only need to adjust the configuration if you want to (de)activate certain WebDAV features in line with your requirements. To check or modify the configuration, choose Content Management Protocols WebDAV in the Configuration iview SAP 4

6 Parameters of the WebDAV Protocol Used Parameter Required Description Enable WebDAV Server Yes Determines whether support of the WebDAV protocol is activated in accordance with specification RFC If it is deactivated, only GET, HEAD, and OPTIONS calls are processed. This parameter is activated by default. Extension Ordering Yes Determines whether the support of the WebDAV enhancement for sorted collections is taken into account. This parameter is activated by default. Extension Redirect Ref Yes Determines whether the support of the WebDAV enhancement for redirect links is taken into account. This parameter is activated by default. Extension Deltav Yes Determines whether the support of the WebDAV DeltaV enhancement is taken into account. This parameter is activated by default. Extension dasl Yes Determines whether the support of the WebDAV DASL enhancement is taken into account. This parameter is activated by default. Extension ACL Yes Determines whether the support of the WebDAV ACL enhancement is taken into account. This parameter is activated by default. Typed Properties Yes Determines whether PROPFIND/PROPPATCH takes the enhancement for typed properties into account if property types are specified as attributes in the respective XML element tag. This parameter is activated by default. MS Web Folder Extensions Yes Determines whether custom properties such as DAV:ishidden are generated for Microsoft Web directory clients. This parameter is activated by default. Auto Version Yes Determines whether PUT and PROPPATCH generate a new version of a resource if the resource is not checked out. This allows non-deltav-capable clients to work with a DeltaV server. This parameter is activated by default. gzip Response Yes Determines whether the servlet compresses response bodies with gzip if the client is ready to accept this. This parameter is deactivated by default. Include All Properties Yes Determines whether PROPFIND allprop requests take an additional include element into account that specifies custom properties. This parameter is activated by default. Expected Check In URI Yes Determines whether CHECKIN and CHECKOUT take the expected check-in URI element into account in requests. This parameter is activated by default. Allow Depth Infinity Yes Determines whether PROPFIND calls are allowed with unlimited depth. Deactivated by default SAP 5

7 Get Collection Yes Collections normally have no content. This parameter determines whether the servlet generates content, for example, an HTML page that lists the subordinate objects of the collection. This parameter is deactivated by default. Get Extensions Yes Determines whether various enhancements for GET, specified in the query parameters for the root collection, are supported. This parameter is activated by default. Root Collection Yes Determines whether the WebDAV servlet generates a virtual root collection that contains all configured repositories. The default value is true. This parameter is activated by default. Root Collection Config Properties Max WebDAV Request Size Yes No Determines whether the affected properties are designated as dead properties of the root collection. This parameter is deactivated by default. Maximum size of a request in bytes Enhancing the KM System Landscape Before you create a WebDAV repository manager, you need to create a new system in the systems.xml file. Open the systems.xml file from the \irj\services\knowledgemanagement\etc\landscape\systems.xml directory. There are two scenarios to choose between when configuring the systems.xml file: Single User Scenario All Portal users access the WebDAV server with the same username. Advantages: The configuration is simple. This solution is supported by the Portal server. Disadvantage: No user-specific authorizations are taken into account as all users access the WebDAV server with the same user profile. This solution should only be used in exceptional cases. The scenario with user assignment is to be preferred. The entry in systems.xml for the connection of a second Portal server might appear as follows: <SYSTEM:System id="webdav-system" type="webdav"> <SYSTEM:Description locale="en" description="portal2"/> <SYSTEM:Property name="user" value="admin"/> <SYSTEM:Property name="password" value="admin"/> <SYSTEM:Property name="server" value=" </SYSTEM:System> Choose a unique ID for the system SAP 6

8 At present, only the admin user (password=admin) can be used when connecting a second Portal server. In the server property, enter the URL of the WebDAV server with the required directory. Save the systems.xml file and restart the Portal. User Mapping Scenario Access to the WebDAV server takes place with user assignment. Each user with defined authorization accesses the WebDAV server with a valid username and password. <SYSTEM:System id="webdav-system" type="webdav"> <SYSTEM:Description locale="en" description="portal2"/> <SYSTEM:Property name="server" value=" </SYSTEM:System> Choose a unique id (it must also be used in the Portal systems.xml file). In the server property, enter the URL of the WebDAV server with the required directory. Save the systems.xml file and restart the Portal Modifying Credentials For a scenario with user assignment, you have to adjust the credentials.xml file. Enter the following section: <CREDENTIALS:System type="webdav"> <CREDENTIALS:Credential name="user"> <CREDENTIALS:Property name="type" value="text"/> <CREDENTIALS:Property name="prompt" value="user"/> </CREDENTIALS:Credential> <CREDENTIALS:Credential name="mappedpassword"> <CREDENTIALS:Property name="type" value="password"/> <CREDENTIALS:Property name="prompt" value="password"/> </CREDENTIALS:Credential> </CREDENTIALS:System> Save the file Enhancing the Portal System Landscape You have to enhance the Portal system landscape for a scenario with user assignment. 1. In the System Configuration workset, choose System Landscape. 2. Download the systems.xml file using the Download function SAP 7

9 Open the file and add the following section: <System name="webdav-system"> <Title multilingual="true"> <pcd:titletext language="de">webdav-system</pcd:titletext> <pcd:titletext language="en">webdav-system</pcd:titletext> </Title> <Description multilingual="true"> <pcd:descriptiontext language="en">webdav System</pcd:DescriptionText> <pcd:descriptiontext language="de">webdav System</pcd:DescriptionText> </Description> <Accessibility value="true"/> <Attributes> <pcd:attribute name="usermappingtype" value="admin,user"/> <pcd:attribute name="credentials.user.type" value="text"/> <pcd:attribute name="credentials.user.prompt" value="user"/> <pcd:attribute name="credentials.user.index" value="1"/> <pcd:attribute name="credentials.mappedpassword.type" value="password"/> <pcd:attribute name="credentials.mappedpassword.prompt" value="password"/> <pcd:attribute name="credentials.mappedpassword.index" value="2"/> </Attributes> </System> For correct user assignment, you have to enter identical systems (for example, name="webdav-system" and id="webdav-system")in both system.xml files. Enter appropriate names in the TitleText and DescriptionText properties. You can use the UserMappingType property to define whether only administrators, only users, or both are able to enter their user data in the Portal (see section ). You should normally enter admin,user. Save your changes. 3. Reload the file to the Portal using the Upload function. 4. Restart the Portal Creating a Cache For performance reasons, you should create a separate cache for each WebDAV repository manager. Proceed as follows: 1. In the KM Admin workset, choose Configuration Content Management Utilities Caches Memory Cache. 2. Choose New to create a new cache, and set the parameters SAP 8

10 Example of a cache configuration: Name = ca_webdav_demosystem Singleton = Average Entry Size = 0 bytes Capacity = 100 entries Entry Default Time to Live = 300 seconds Maximum Cache Size = 0 bytes Maximum Entry Size = 0 bytes 3. Save your copy. 4. Restart the Portal Creating and Configuring a WebDAV Repository Manager Create a WebDAV repository manager. 1. In the KM Admin workset, choose Configuration Content Management Repository Managers WebDAV Repository. 2. Choose New to create a new repository manager. 3. Enter the repository manager parameters (see the table below). Note that not every WebDAV server provides all available WebDAV features. WebDAV Repository Manager Parameters Parameter Name Description Prefix Proxy Host Proxy Port Proxy System ID System ID System Path Active Description Name of the repository manager Extended name of the repository manager Indicates the name (URI prefix) under which the repository is listed in the root directory (in the KM Admin workset under Repositories). Hostname of the HTTP proxy to be used for this repository. Port number under which the proxy in Proxy Host can be reached ID specification of a proxy server in the system landscape. This parameter is to be used instead of Proxy Host if the proxy server requires authentication. ID of the WebDAV system that is registered with the system landscape. In our example: System ID = WEBDAV-SYSTEM Optional suffix for the server URL of the WebDAV system. The server URL is a property of the landscape system. System Path allows the same system to be used for different paths in the URL namespace. The repository manager is activated after the configuration and restart of the Portal. It can be deactivated if problems arise SAP 9

11 Read-only ACLs Send Events Use System Default Proxy Settings Property Search Manager Class Security Manager Class Cache Timeout HTTP Timeout Defines whether the security manager is to allow changes to ACLs or whether they should be write-protected. This parameter is deactivated by default. Specifies whether the repository sends events when operations such as delete, update content and so on are carried out on resources. This parameter has to be activated if you want the repository to send events. This is necessary for the use of services such as the subscription service. This parameter is activated by default. Defines whether the standard values http.proxyhost and http.proxyports of the Java Virtual Machine (VM) are taken into account. These values can be set when you start the VM. As long as no other settings are valid for Proxy Host or Proxy System, the standard values http.proxyhost and http.proxyport of the Java Virtual Machine (VM) are used. Java Class that the sub-manager implements for the property search. Choose the WDPropertySearchManager. Java class that the security manager implements and that controls access to repository content. If you want CM to carry out an authorization check when accessing resources, you need to specify a security manager. If you want the security settings to be reproduced from those of the WebDAV server, you should use the WDAclSecurityManager: com.sapportals.wcm.repository.manager.webdav.acl.wdaclsecuritymanager If you use the WDAclSecurityManager, the WebDAV server needs to be running in the same user domain. The WebDAV users need to match the local users. Extension ACL needs to be activated in the configuration of the protocol (see section ). Timeout in milliseconds for resources in the cache. After this period of time (at the latest), resources are checked against the WebDAV server. The optimum value depends on the availability of the WebDAV server. Timeout in milliseconds after which operations on the server are terminated. Example: ms = three minutes. The value 0 means that there is no timeout. Idle time is the time between successful read/write operations. If the WebDAV server does not answer a request within the defined period of time, for example, the request is considered to have failed and an error is returned. Note that the complete answer is not read at this point. If the WebDAV repository manager reads a large document, the idle time counts as the time between successful read operations of sub-data, not as the time needed to call the complete document. (Comment: HTTP timeout determines the SOTIMEOUT value of the connection socket to the remote server) SAP 10

12 Repository Services ACL Manager Cache Cache Versioning Manager Class Selection of repository services that you want to use for a repository. The following services are supported by the WebDAV repository manager: Service ACL service (svc_acl) Access statistics service (accessstatistic) Subscription service (subscription; subscription_collaboration) Logger service (logger) Feedback (feedback) Personal notes (personalnote) Discussion (discussion) Comments (comment) Rating (rating) Note the following for the application property service (properties): If the available WebDAV server is public (that is, other users or applications access it), no application property service should be used. If you want to use this service, ensure that the repository is only used by the Portal. Document changes that are not made by the repository are not tracked by the application property service. Application properties can be lost or assigned to the incorrect resource in this way. ID of cache for resource ACLs: rsrcacl. This parameter is needed if an ACL security manager is specified in the Security Manager Class parameter. The ca_webdav cache is preset in the KM standard configuration that is delivered with CM. ID of memory cache that is to be used by the WebDAV repository for the caching of resources. Select the cache that you created in Java class that the sub-manager implements for the version management: com.sapportals.wcm.repository.manager.webdav.wdversioningmanager Versioning is only possible if the remote server supports the WebDAV DeltaV protocol. Extension DeltaV needs to be activated in the configuration of the protocol (see section ). 4. Then choose Save to save the configuration of the repository manager. 5. Restart the Portal SAP 11

13 Example of a WebDAV repository manager configuration: Description = WebDAV Demo-System Prefix = /webdavdemosystem System ID = WEBDAV-SYSTEM Active = Send Events = Property Search Manager Class = [...].WDPropertySearchManager Security Manager Class = [...].WDAclSecurityManager Cache Timeout = 500 Repository Services = comment,discussion,feedback,properties,personalnote ACL Manager Cache = ca_rsrc_acl ACL Manager Factory = acl_jdbc_rep Cache = ca_webdav_demosystem Versioning Manager Class = com.sapportals.wcm.repository.manager.webdav.wdversioningmanager Enhancing Personal Settings (User Mapping Scenario) All users of the WebDAV system need to enter their user data into the Portal to ensure the correct assignment of authorizations. This avoids the need for the user to log on additionally to the WebDAV system when the Portal is started. Proceed as follows: 1. Choose Personalize Portal (1) 2. Select your WebDAV system in the User Assignment section under Data Source (2). 3. Enter appropriate data in the User and Password fields (3). 4. Save your entries. a 2002 SAP 12

14 3.3.9 Creating and Configuring an Index You need to create an index under KM Admin Index Administration in order to also be able to start a search in this repository. You are in the Index Administration iview. 1. Choose Create. You reach the New Index dialog box. 2. Enter the necessary data. Parameter ID (obligatory) Name Group Service Description The ID uniquely identifies an index in the system. Enter an appropriate name. This name is displayed for all users in the search options (under Resources to search). Select an index group. If you have lots of indexes, use index groups to group indexes according to content criteria. Select an index service. Only index services defined in the configuration are offered for selection. Examples of services are Search and Classification. 3. Choose Create Index. A status message tells you whether the index could be created. In the next step, you assign the WebDAV repository to the index Assigning Indexes to the WebDAV Repository Proceed as follows to assign the WebDAV repository to the index. 1. You are in the list of available indexes. Click on the ID of the index just created to reach the index properties of the index in question. 2. Choose Folders. 3. In the bottom half of the screen, choose the WebDAV repository created by you, and choose Add Folder. The repository is added to the list in the upper area of the window. 4. Save your entries. All documents in the folder or repository are now indexed. This also applies to sub-folders and documents contained therein. Newly created files in this folder are automatically indexed by the system. As soon as the repository has been indexed, you can find documents that are stored there in the Portal SAP 13

15 Activating Subscription Event Mapping for the Repository You need to activate Subscription Event Mapping for the WebDAV repository before you are able to use subscriptions for it. Proceed as follows: 1. In the Configuration iview, choose Content Management Repository Services Subscription Event Mapping. 2. Choose StandardEventMapping and assign the WebDAV repository to the Repositories parameter. 3. Choose the following settings for the other parameters: Link handling = use link Mapping class = [...]SubscriptionEventMapStandard Relation = to URL 4. Save your entries and restart the Portal. You are now able to create subscriptions and can thereby be informed automatically when changes are made to documents. 4 Appendix 4.1 Troubleshooting This section lists frequently occurring problems in connection with WebDAV. Error message when creating a Web folder: The folder you entered does not appear to be valid. Please choose another. Check that you specified the correct path to the WebDAV server. The newly created WebDAV server does not appear in the selection of available repositories. Restart the Portal. Check whether the System ID parameter in the WebDAV repository manager configuration matched the ID property in the systems.xml file of the Portal. Are the other entries in the systems.xml file correct? Further problems are listed in CSN Note in the WebDAV section SAP 14

16 5 Copyright No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, WINDOWS, NT, EXCEL, Word, PowerPoint and SQL Server are registered trademarks of Microsoft Corporation. IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iseries, pseries, xseries, zseries, z/os, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, Informix and Informix Dynamic ServerTM are trademarks of IBM Corporation in USA and/or other countries. ORACLE is a registered trademark of ORACLE Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, the Citrix logo, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, MultiWin and other Citrix product names referenced herein are trademarks of Citrix Systems, Inc. HTML, DHTML, XML, XHTML are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. JAVA is a registered trademark of Sun Microsystems, Inc. JAVASCRIPT is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MarketSet and Enterprise Buyer are jointly owned trademarks of SAP AG and Commerce One. SAP, SAP Logo, R/2, R/3, mysap, mysap.com and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are trademarks of their respective companies SAP 15