Configuring the Simple Object Access Protocol (SOAP) Adapter

Objectives

After completing this lesson, you will be able to:

Configure the SOAP sender adapter
Configure the SOAP receiver adapter

SOAP Sender Adapter

The Simple Object Access Protocol (SOAP) sender adapter runs on the Adapter Engine and is configured through a communication channel. Apart from the quality of service (QoS), for example, Exactly Once (EO), the standard interface namespace and the standard interface name are also stored in the standard SAP Process Integration (PI) parameter area of the communication channel, that is, the outbound interface specification.

The Uniform Resource Locator (URL) is important for you, as the sender, because you use the URL for the HyperText Transfer Protocol (HTTP) request. The URL also contains the name of the communication channel as well as the sender communication component (and possibly the sender party).

Using these settings, you, as the sender, must send at least one SOAP envelope with a SOAP body, which contains the payload.

Plain HTTP with SOAP Sender Adapter

If you, as the sender, transfer a plain XML document using HTTP post to the SOAP sender adapter, you do not need the SOAP envelope or the SOAP body. In this case, select the Do not use a SOAP Envelope parameter in the SOAP sender communication channel, and you, as the sender, must transfer the nosoap = true parameter to the URL.

In the Web Services Description Language (WSDL) file for a SOAP call, SOAP is the standard format for Web services.

A WSDL file can be created for a sender system in the Integration Directory (ID) as a description for the call. The sender system sends a SOAP call to the SOAP adapter. Start the wizard from the menu Tools → Define Web Service. Here, you enter a receiver interface, among other things.

Note

The SOAP adapter can be configured to use the XI 3.0 Message Protocol for Proxy use. This will be discussed in a later lesson.

Caution

The wizard suggests a URL that points to the central Integration Engine (IE) and not to a SOAP sender adapter. Enter the URL manually.

Configure a SOAP Sender Adapter

Business Scenario

You want to receive SOAP calls from a sender system on SAP Process Integration, which requires you to set up a SOAP sender communication channel.

Caution

This exercise doesn't work with Google Chrome Browser or Microsoft Edge. Use Microsoft Internet Explorer instead.

Exercise Information

Note

In this exercise, when the values include ##, replace the character with a two-digit number (01–30).

Exercise Options

You can perform this exercise in two ways:

Live Environment: choose Start Exercise, and from the entry page choose Open PDF Document. Follow the steps described in this pdf in your own system landscape.
Simulation: choose Start Exercise, and from the entry page choose Start Tutorial. Watch the step-by-step instructions within the simulation.

Note

We recommend running the simulation first.

ExerciseStart Exercise

Task 1: Configure a SOAP Sender Adapter

Steps

Create a communication channel of adapter type SOAP sender for the BS_BIT500_##_A business system and name it SOAP_Sender_## using the EO QoS.
1. In SAP NWDS 7.5 open SAP Process Integration Designer Perspective.
2. On the PI Explorer tab page expand the Systems folder.
3. Right-click your Sender Business System BS_BIT500_##_A and choose New Channel.
4. In the Create a Channel Dialog dialog box, enter the following data:
  Field Name Entry
  Channel Name SOAP_Sender_##
  Communication Component BS_BIT500_##_A
5. Choose Finish.
6. In the General Details area, set Direction to Sender.
7. In the Adapter Type field, select SOAP | SAP BASIS 7.50.
8. Switch to the Adapter Specific view.
9. In the Quality of Service field, enter Exactly Once. Save and activate your changes.
Change the iFlow called iFlow_MaterialA_MaterialsB_## to use the SOAP_Sender_## communication channel instead of HTTP_Sender_##.
1. Open your iFlow iFlow_MaterialA_MaterialB_##.
2. In the iFlow, select the line between the sender the envelope (color changes to orange).
3. Right-click and choose Assign Referenced Channel.
4. Select the SOAP_Sender_## channel and choose OK.
5. Save, activate, and deploy your iFlow.
Open the SOAP client form, specify the parameters including the payload, and send a message.
1. In the browser call, http://nwktdc00.wdf.sap.corp:50000/dir.
2. On the Additional Information area, choose SOAP Client.
3. On the SOAP Client form web page, choose the Guess button to expand the URL to include the host and HTTP port of the central Adapter Engine, on which you set up your SOAP sender adapter.
4. Specify the necessary entries as the URL suffix for your communication channel: channel=:BS_BIT500_##_A:SOAP_Sender_##. (Replace ## with your group number.)
5. Choose the Guess button in the Payload area. The payload will be created.
6. Customize the contents as required. Replace ## with your group number. Replace MaterialID P-100 through MaterialID BIT500_##.
7. Choose the Send button.
Check the Message Monitor in the Configuration and Monitoring Home.
1. Navigate to http://nwktdc00.wdf.sap.corp:50000/dir and chooseConfiguration and Monitoring Home. Alternatively go to http://nwktdc00.wdf.sap.corp:50000/pimon.
2. Go to Monitoring → Adapter Engine → Message Monitor → PI Messages and check Message List.
3. Your message should be delivered. Select it and check the Message Log tab to understand how the message got processed.
Display the file created in your directory.
1. On your PI tools page, http://nwktdc00.wdf.sap.corp:50000/dir, click How to open share for file adapter files.
2. Follow the instructions to connect to the Y: drive.
3. In the File Download-Security Warning dialog box, choose the Open button.
4. In the Internet Explorer-Security Warning dialog box, choose the Run button. This opens the tmp directory.
5. In the tmp directory, choose the folder for your group.
6. In the group-folder, open the XML file and check the result.

Field Name	Entry
Channel Name	SOAP_Sender_##
Communication Component	BS_BIT500_##_A

SOAP Receiver Adapter

The Simple Object Access Protocol (SOAP) receiver adapter runs on the Adapter Engine and is configured using a communication channel. Enter the URL in the target system along with security and logon parameters.

In the conversion parameter area, you can influence how the SOAP document that is sent to the target system is structured.

Next lesson