Index Management Web Service 

The Index Management Web service provides access to the Index Management Service in Knowledge Management. The basic function is to allow searching for documents in KM. In addition, the Web service also offers the means to maintain indexes, attach data sources, or trigger re-indexing.

 

Prerequisites

The Web service requires authentication so that only authenticated users can access the Web service’s methods. By default, the Web service accepts basic authentication with user name and password or SAP logon tickets. If you want to use SAP Logon Tickets between two application servers, you need to configure a trusted relationship between the Application Server on which the Web service is running and the remote Application Server Java or ABAP system.

For more information about configuring a trusted relationship, see the relevant documentation on the Web service infrastructure.

 

Searching For Documents

You can perform searches either in one or more folders or in one or more indexes. The Web service provides the methods searchFirstChunkInFolders and searchFirstChunkIndexes for this purpose. Depending on the method you use, you provide either a list of RIDs or a list of index IDs. For performance reasons, both methods do not return all search results, but only the first n result sets. In both methods, you can specify the maximum number of results returned with the first call . Both methods return a searchResultChunk, which contains the found resources, the total number of results found, and a token that can be used to search for the next n results. To search for the next n results, you must use the method searchNextChunk. This method receives the token that was returned by searchFirstChunkInFolders or searchFirstChunkIndexes and returns the next n results. Each token is assigned to a search session on the server. The search session has a timeout, which can be specified in the methods searchFirstChunkInFolders and searchFirstChunkIndexes. The method searchNextChunk can only be called as long as the search session assigned to the token exists on the server. If the session timed out in the meantime, the method searchNextChunk will return a timeout exception.

Similar to the repository framework Web service, you can use a FetchGroup to specify which aspects of the resource should be returned (for example, system properties, all properties, no properties, AccessURL, or DetailsURL).This allows you to transfer only the data that you are interested in. This ensures that the data transfer does not impact system performance.

 

Maintaining Indexes

You can also use the Index Management Web service to maintain indexes. You start by creating a new index, then attach one or more data sources to the index, and finally trigger the re-indexing process. All Index Management actions are sent asynchronously to the TREX server and might not be finished immediately after the Web service call returns.

 

Web Service Location

The WSDL for the Index Management Web service is located at

http://<server>:<port>/IndexManagementWS/Config1?wsdl

To get an initial overview of the Web service methods provided, you can use the Web service Navigator, which you  can access through the Application Server homepage. The Web Service Navigator shows all deployed Web services with their methods and allows you to test each method of the Web services.