Routing Messages Through Adapter for SAP

The transport indicates how Adapter for SAP will route the message (for example, route it to a service on the local or a remote host). The transport can be one of the following:

Based on the transport you select, the Notification Editor displays additional fields required by the selected transport.

You can write an ABAP wrapper that calls a function module with an RFC destination and add an additional table to the call statement.

The name of the table must be SBCHEADER and it must have the following structure.

This structure is defined in the SAP system starting with release 4.6A under the name SBCCALLENV. If you do not have this structure in your system, define a similar one as above.

The header table can contain an arbitrary number of key/value pairs. If you want to pass additional keys to Adapter for SAP, you can define your own name/value pairs and insert them into the SBCHEADER table.

You would read out these fields inside a java module in Adapter for SAP with the following statements (case-sensitive):

IDataCursor idc = pipeline.getCursor();  
IData sbcHeader = IDataUtil.getIData( idc, "sbcHeader");  
if (sbcHeader != null)  
{  
     IDataCursor headerCursor = sbcHeader.getCursor();  
     String property = IDataUtil.getString( headerCursor, "myProperty");  
     headerCursor.destroy();  
     System.out.println("Property was "+property);  
}  
idc.destroy();

If you want Adapter for SAP to invoke a routing notification to route the RFC, the header table must contain the sender and receiver for the RFC. When determining the routing notification to invoke, the routing listener uses the sender and receiver you specify in the header table and matches message types against the RFC name in place of a message type.

To have Adapter for SAP use a routing notification, include the following information in the header table:

If you want to control the routing of an RFC from the SAP system directly (without requiring a routing notification on Adapter for SAP), you can include transport information in the header table. The transport indicates where Adapter for SAP is to route the incoming RFC. When Adapter for SAP receives an RFC that specifies the transport, it does not invoke a routing notification but directly passes the RFC to the specified transport. The transports that you can identify in a header table to dynamically route an RFC through Adapter for SAP are:

• Route the RFC to an Integration Server service
• Route the RFC to an SAP system
• Post the RFC-XML to a URL

The following describes the key/value pairs you must specify for each transport you can specify.

• To route the RFC to an Integration Server service, use Integration Server service transport.

  Key	Value
  transport	IS This value identifies the transport. Specify the value exactly as specified above.
  serverAlias	Name of the Integration Server on which the service to invoke resides. If the service resides on the server that routes the message, specify (local). Otherwise, specify an alias for a remote server. For the routing to be successful, the server routing the RFC must have the defined alias for the remote server.
  folderName	Name of the folder in which the service resides. The folder name is case sensitive; use the exact combination of upper and lower case letters.
  serviceName	Name of the service to which to pass the RFC. The service name is case sensitive; use the exact combination of upper and lower case letters.
  valueScope	Where you want Adapter for SAP to store the connection to the remote server. To save the connection in your own session, specify SESSION. Use SESSION when the work being performed requires state be maintained. To save the connection in a shared area, specify GLOBAL. Use GLOBAL when the work being performed is stateless.

• To route the RFC to an SAP system, use the RFC transport.

  Key	Value
  transport	RFC This value identifies the transport. Specify the value exactly as specified above.
  serverName	RFC Connection alias to which you want the RFC routed.

• To post the RFC-XML to a URL, use the XML transport.

  Key	Value
  transport	XML This value identifies the transport. Specify the value exactly as specified above.
  url	URL to which you want to post the RFC.
  xmlType	The XML format you want the routing listener to use for the RFC. Specify SAP-XML if you want the RFC in an XML format that is compliant with the SAP XML specification. Specify Values-XML if you want the RFC in webMethods native XML format.
  httpUser	User name to supply for a user name/password authentication challenge (optionally).
  httpPassword	Password to supply for a user name/password authentication challenge (optionally).

For sending RFCs as bXML, please refer to RFC Based XML Messages Using IFR Format.

It is not always necessary to specify routing notifications. If you want to call a BAPI from an ABAP report in your SAP system, you can also add the SBCHEADER parameter to your function module call. This parameter can be filled with key-value pairs that describe in detail how the message should be routed. At the moment, it is only possible to route BAPI-calls to the XML transport. To do this, use the following key pairs in the SBCHEADER table:

For sending RFC based XML messages, only the first five parameters are supported. You can specify this parameter to your ABAP RFC as follows:

DATA header like SBCCALLENV occurs 1 with header line.  
*... some code lines omitted  
CALL FUNCTION 'BAPI_COMPANYCODE_GETLIST'  
  DESTINATION 'ISCER'  
IMPORTING  
  RETURN = returnCode  
TABLES  
  COMPANYCODE_LIST = companyCodes  
  SBCHEADER = header  
.

For a synchronous example, see Calling a BAPI Synchronously from SAP System. For an asynchronous example, see Calling a BAPI Asynchronously from an SAP System.

You can also generate XML calls for RFC function modules that are based on the IFR XML format. To do this, select bXML as the XMLType at the routing notification for RFC messages, and ensure that useBAPI is set to No.

Perform the following steps to FTP an RFC-XML document to the routing listener:

open <Integration Server host> <port of ftp listener>  
username: Administrator  
password: manage  
cd ns/pub/sap/transport/RFC/InboundProcess  
bin  
put example.xrfc

The FTP client should check the return code to find out whether the document processed properly.

To send an RFC-XML document to the routing listener in an e-mail message, put the document into an attachment whose name ends with .xrfc. In the subject line of the e-mail specify pub.sap.transport.RFC:InboundProcess.

Inbound messages in the BAPI-based XML format can be easily dispatched using routing notifications.

For each BAPI sent via XML to Adapter for SAP, a corresponding routing notification should exist. If no entry exists, the message will not be executed and Adapter for SAP will throw an exception.

The message type used in the routing notification for BAPIs is constructed from the concatenation of the business object name and the BAPI name, which are separated by a dot. (the syntax is <Business Object>.<BAPI method name>).

The only transport applicable to inbound BAPI calls is the BAPI transport.

To apply the routing notification, the XML message should be posted to Adapter for SAP. The receiving service should be pub.sap.transport.BAPI:InboundProcess.

Execute an HTTP post operation to:

http://<host>:<port>/invoke/pub.sap.transport.BAPI/InboundProcess

In the HTTP body, an XML message specifying the BAPI-call as described above must be sent. You have to use the HTTP content type application/x-sap.busdoc when posting to Adapter for SAP.

POST /invoke/pub.sap.transport.BAPI/InboundProcess HTTP/1.0  
Content-Type: application/x-sap.busdoc  
User-Agent: Java1.1.8  
Host: localhost:5555  
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*;  
q=.2  
Connection: keep-alive  
Content-length: 817  
<?xml version="1.0"  
encoding="iso-8859-1"?>  
<biztalk_1 xmlns="urn:biztalk-org:biztalk:biztalk_1">  
  <header>  
   <delivery>  
    <message>  
      <messageID>0A125F1315B3D24B0000001E</messageID>  
      <sent>2000-06-20T09:58:00</sent>  
    </message>  
    <to>  
      <address>urn:sap-com:logical-system:SAPSYS0001</address>  
    </to>  
    <from>  
     <address>urn:sap-com:logical-system:SAPADA0001</address>  
    </from>  
   </delivery>  
  </header>  
<body>  
  <doc:CompanyCode.GetList xmlns:doc="urn:sapcom:  
   document:sap:business" xmlns="">  
   <CompanyCodeList>  
    <item>  
     <COMP_CODE></COMP_CODE>  
     <COMP_NAME></COMP_NAME>  
    </item>  
   </CompanyCodeList>  
  </doc:CompanyCode.GetList>  
</body>  
</biztalk_1>

You can control whether the BAPI should be called synchronously via RFC or asynchronously via ALE by the<referenceID> element in the BizTalk header.

If the <referenceID> element is specified and contains a valid SAP transaction ID (TID), the BAPI outbound process automatically chooses the ALE format, otherwise, if the element is omitted, the message will be processed synchronously.

For both synchronous and asynchronous calls, technical processing errors are reported by an XML response document containing a fault descriptor.