Publishing Service Documentation Links to a Services Registry

Prerequisites

You use SAP Solution Composer.

Procedure

When you publish a Web service to a Services Registry, you can also include a documentation link. A documentation server path prefix must first be active in the provider system. To configure and activate a documentation server path prefix, you can either use transaction WS DOCU_SERVER or SOA Manager. In SOA Manager, on the Technical Administration tab, go to SAP Client Settings and choose the Documentation Server tab. Here, you can optionally specify a software component if there are multiple documentation servers configured for different software components.

When a documentation server path prefix has been configured and activated, a documentation URL is automatically set up for each service definition and published in the Services Registry when a Web service is published.

Example

Below is an example of a documentation link:

http://main.wdf.sap.corp:1080/socoview/get_bpp_docu.asp?SC-NAME=SAP_BASIS&SC-VERSION=711&TYPE=ifmoper&NAME=FlightSeatAvailabilityQuery_In&NAMESPACE=http://sap.com/xi/XI/Demo/Airline

The parameters used are as follows:

SC-NAME

Software component name

SC-VERSION

Software component version

TYPE

Object type

NAME

Name of object

NAMESPACE

Namespace of object