The KM Web Service API was introduced for SAP NetWeaver 7.0 SPS 13 and offers a new possibility to connect to KM functions remotely. In this blog I will give a first impression what capabilities the new API will offer. h5. How to get the WSDL of the KM Web Services ? Of course to get started with Web Services at all it is required to get access to the WSDL of the called Web Service. For KM Web Services you will find the WSDL description in the *Web Service Navigator* ([http://:/wsnavigator | http://:/wsnavigator]) of your SAP NetWeaver installation. 
h5. RepositoryFrameworkWS and IndexManagementWS - new Web Services in SAP NetWeaver ! There are two different Web Services in the SAP NetWeaver shipment which allow a remote KM access. The *Repository Framework Web Service* (RepositoryFrameworkWS) offers basic functions like create, copy, move, rename or delete operations on documents (resources) in the KM repository framework. It is mainly designed for executing functions on top of a repository manager. You also can get navigations trees (folder hierarchies) and metadata of documents with this Web Service. The followinging aspects of a repository manager are supported: 0.1. Lookup: This aspect covers lookup operations. Lookup operations are operations used to look up resources identified by resource identifiers in an repository. The resource identifier of a resource is the address of the resource and identifies exactly this single resource. 0.2. Namespace: This aspect covers namespace operations. Namespace operations are operations reading or manipulating the hierarchy of resources in the repository. Retrieving all child resources of a collection is an example of reading - creating a new document is an example of writing. 0.3. Property: This aspect covers property operations. Properties are bits of information attached to a resource. They have a name, are of a predefined type, e.g. boolean or string and have one or multiple values. Retrieving all properties of a resource is an example of reading - setting a new property is an example of writing. 0.4. Content: Content is stored in a byte array and only documents may have content. When a content is set, certain properties are set along with, e.g. the content length or type. Thoose properties are also available as one single object, the content metadata object. Retrieving content or content metadata is an example of reading - setting content is an example of writing. 0.5. Lock: Locking a resource helps synchronizing on resources. Different locks are available, e.g. for reading or writing and can be set or removed. Locks have a timeout in order to automatically free resources. Getting all locks on a resource is an example of reading - aquiring a lock on a resource is an example of writing. 0.6. Security: When a read or write operation on an aspect is called the caller must have certain permissions to do so, e.g. user A may read, but may not create new resources. These permissions can be queried or set using this aspect. Checking for a certain permission for a user is an example of reading - setting the permission for a certain user is an example of writing, but not yet supported. 0.7. Versioning: Resources can be set under version control, meaning that all changes to the resources can be tracked. Only checked out resources can be modified and all changes will be collected and assigned to the revision given back by the system when checking the resource in again. Querying the revision history is an example of reading - checking a resource in is an example of writing. The *Index Management Web Service* (IndexManagementWS) offers indexing and search capabilities on top of KM's index management service. The followinging aspects of the index management are supported: 0.1. Index: This aspect covers index management operations. It provides some basic management features to create/delete indexes and to attach/detach datasources as well as the search funtionality. 0.2. PerfIdxMgmt: This aspect covers performance issues and is needed for Web Service maintenance purposes only. Performance information supports developers in using and optimizing the Service. Among other information the processing time (on average/last call) or failure rate (number of caught exceptions in relation to number of made calls) can be queried per Web Service method. 0.3. CfgIdxMgmt: This aspect covers config operations and is needed for Web Service maintenance purposes only. Configuration settings define various runtime properties of the Web Service. Among other settings tracing or logging can thereby be switched on or off. The following diagram will show a simplified architecture of the KM Web Services:
h5. RepositoryFrameworkWS and IndexManagementWS - new Web Services in SAP NetWeaver ! There are two different Web Services in the SAP NetWeaver shipment which allow a remote KM access. The *Repository Framework Web Service* (RepositoryFrameworkWS) offers basic functions like create, copy, move, rename or delete operations on documents (resources) in the KM repository framework. It is mainly designed for executing functions on top of a repository manager. You also can get navigations trees (folder hierarchies) and metadata of documents with this Web Service. The followinging aspects of a repository manager are supported: 0.1. Lookup: This aspect covers lookup operations. Lookup operations are operations used to look up resources identified by resource identifiers in an repository. The resource identifier of a resource is the address of the resource and identifies exactly this single resource. 0.2. Namespace: This aspect covers namespace operations. Namespace operations are operations reading or manipulating the hierarchy of resources in the repository. Retrieving all child resources of a collection is an example of reading - creating a new document is an example of writing. 0.3. Property: This aspect covers property operations. Properties are bits of information attached to a resource. They have a name, are of a predefined type, e.g. boolean or string and have one or multiple values. Retrieving all properties of a resource is an example of reading - setting a new property is an example of writing. 0.4. Content: Content is stored in a byte array and only documents may have content. When a content is set, certain properties are set along with, e.g. the content length or type. Thoose properties are also available as one single object, the content metadata object. Retrieving content or content metadata is an example of reading - setting content is an example of writing. 0.5. Lock: Locking a resource helps synchronizing on resources. Different locks are available, e.g. for reading or writing and can be set or removed. Locks have a timeout in order to automatically free resources. Getting all locks on a resource is an example of reading - aquiring a lock on a resource is an example of writing. 0.6. Security: When a read or write operation on an aspect is called the caller must have certain permissions to do so, e.g. user A may read, but may not create new resources. These permissions can be queried or set using this aspect. Checking for a certain permission for a user is an example of reading - setting the permission for a certain user is an example of writing, but not yet supported. 0.7. Versioning: Resources can be set under version control, meaning that all changes to the resources can be tracked. Only checked out resources can be modified and all changes will be collected and assigned to the revision given back by the system when checking the resource in again. Querying the revision history is an example of reading - checking a resource in is an example of writing. The *Index Management Web Service* (IndexManagementWS) offers indexing and search capabilities on top of KM's index management service. The followinging aspects of the index management are supported: 0.1. Index: This aspect covers index management operations. It provides some basic management features to create/delete indexes and to attach/detach datasources as well as the search funtionality. 0.2. PerfIdxMgmt: This aspect covers performance issues and is needed for Web Service maintenance purposes only. Performance information supports developers in using and optimizing the Service. Among other information the processing time (on average/last call) or failure rate (number of caught exceptions in relation to number of made calls) can be queried per Web Service method. 0.3. CfgIdxMgmt: This aspect covers config operations and is needed for Web Service maintenance purposes only. Configuration settings define various runtime properties of the Web Service. Among other settings tracing or logging can thereby be switched on or off. The following diagram will show a simplified architecture of the KM Web Services:
12 Comments
