Show TOC

Function documentationRuntime Services

 

Knowledge Repository: Retrieval Service

The retrieval service consists of a set of APIs for a business application to retrieve the information of one or more knowledge entities in different formats. A knowledge base name and knowledge entity identifiers are required information to use the retrieval service. It is possible to retrieve details of a knowledge entity as a string of text format, HTML format, XML format, or table of texts.

The basic format for a knowledge entity's detail is in XML. Other formats are transformed from the XML via XSL transformations. Each knowledge base can be configured to have at least two XSLTs, one for XML/HTML transformation, and another for XML/text transformation. You can create your own XSLTs and assign them to any knowledge base in the Customizing activity Name and Configure Knowledge Base.

The APIs for retrieval service are located at function group CRM_SAF_API_KB or RFC-enabled function group EI_SAF_RFC_KB in package EI_SAF_KB.

The delivered XSLT examples can be found in package EI_SAF_KB.

XSL Transformations Delivered as Out-of-the-Box Solutions

Knowledge Base

XSL Name for XML/HTML

XSL Name for XML/Text

Generic format

XSL_KB_SAP

XSL_KB_SAP_TEXT

Search Engine: Query Service

The query service provides APIs for a business application to submit a search query to a search engine. The search engine then returns a list of matched knowledge entities. Inputs of the query service can be free texts, exact phrases, attributes, or any Boolean combination of texts and attributes.

In addition to the standard search capability, a list of enhanced functionality is already integrated with the Software Agent Framework query service:

  • A search query can be submitted to multiple indexes of one search engine.

  • A search query can be submitted to multiple search engines.

  • Information security is implicitly integrated in the query service via Boolean operations.

Search Engine: Classification Service

The classification service provides an API that submits a text query to text-mining functionality.

More Information

Design-Time Services