Entering content frameObject documentation Plain HTTP Adapter Locate the document in its SAP Library structure

Definition

The plain HTTP adapter gives application systems the option of communicating with the Integration Engine and exchanging business data using a plain HTTP connection. Depending on the receiver system, outbound messages can be enhanced with certain information.

Use

The plain HTTP adapter is used by external systems to connect to the Integration Engine using the native HTTP interface (HTTP payload without SOAP envelope). These systems are connected using the internet communication framework of the SAP Web Application Server. For this purpose, the Integration Engine HTTP inbound channel contains an Structure linkHTTP service delivered by SAP, called /sap/xi/adapter_plain.

There are two usage types for the plain HTTP adapter:

Example: Ordering on the Internet with an order number as a response

Example: Ordering on the Internet without confirmation of the purchase

In principle, both scenarios are possible at the Integration Engine HTTP inbound and outbound channels.

In special cases for particular external servers with CGI scripts, for example marketplaces, it is possible to send the payload as an HTML form using HTTP post. The payload is enhanced correspondingly.

Structure

The plain HTTP adapter comprises two parts, namely an inbound adapter by the Integration Engine inbound channel and an outbound adapter by the Integration Engine outbound channel. The outbound adapter requires a corresponding end point from technical routing for each logical receiver of the message.

Plain HTTP: Inbound Channel

You communicate with the Integration Engine plain HTTP inbound channel using a URL (Uniform Resource Locator). The HTTP body is used as the payload for the message. The payload does not contain an envelope with control data for the message you want to create. You must code the control data in the URL as parameters; these parameters are obligatory to be able to generate a message.

Queries entering the plain HTTP adapter must have the following syntax:

http://<hostname:port>/<path>?<query-string>

The query string contains the following data:

The message ID is 32 characters long and must only comprise the characters 0 to 9 and A to F. It is persisted and can therefore be checked for duplication. If the HTTP client (the sender system) cannot provide a message ID, the plain HTTP adapter generates a message ID and forwards it to the application through the Integration Engine. You can then carry out a duplication check at document level, for example, by using the order number.

Plain HTTP: Outbound Channel

The plain HTTP outbound channel is a service provided by the Integration Engine. The system communicates with this interface when technical routing determines a corresponding end point for the logical receiver from logical routing. The system sends the payload of the message to a URL using HTTP, without being enhanced with an envelope.

The plain HTTP adapter gives the receiver system the following specifications:

Specifies the format that the message contents (the payload) should have.

Specifies the character set.

Presents the XML in a URL-enabled format; special characters that could be interpreted as control characters are replaced with escape characters.

Enhances the payload for particular servers (optional, see below).

Enhances the payload for particular servers (optional, see below).

That is: http://<hostname:port>/<path>?<query-string>

You can identify the HTTP port of a SAP Web Application Server using the Structure linkICM monitor.

Enhancing the Payload

Some external systems, for example, Web servers in marketplaces, can only process data if it is sent as an HTML form using HTTP.

A typical HTML form comprises named fields. When transferring a completed form to the server or a CGI program, the data must be transferred in such a way that the CGI script can recognize the fields that make up the form, and which data was entered in which field.

The plain HTTP adapter constructs this format using a prolog and an epilog. Therefore, there is a particular code method that separates form fields and their data from each other. This code method uses the following rules:

Example

This graphic is explained in the accompanying text

Integration

The plain HTTP adapter is part of the Integration Engine. The inbound adapter is fed by the Integration Engine pipeline, and calls this pipeline. Whereas the outbound adapter is called by the pipeline; it can be regarded as a pipeline service and is therefore part of the pipeline itself.

 

 

Leaving content frame