IMS Enterprise Suite Version 2.1 SOAP Gateway: Enabling an IMS application as a web service consumer (asynchronous callout)

Product documentation


This article demonstrates the general steps for an IMS™ application to issue an asynchronous callout request to a web service through IMS Enterprise Suite V2.1 SOAP Gateway. The steps involve creating the required XML converter and connection bundle by using IBM® Rational® Developer for System z® Version 8.0.2 or later, and the SOAP Gateway management utility. This sample is not intended to serve as an end-to-end tutorial.


When an IMS application issues an asynchronous callout request, the application program can terminate and free the dependent region, without waiting for a response. When enabled for asynchronous callout requests, SOAP Gateway listens for new callout requests by continuously issuing the RESUME TPIPE call to IMS Connect. If a callout request message is on the tpipe queue, OTMA sends the callout request to IMS Connect, IMS Connect processes the message, converting the message to XML if necessary, and then sends the message to SOAP Gateway.

In order to demonstrate how to make an asynchronous callout request to a web service, a web service is required. In this sample, we’ll create the data mapping files based on the IMS application source file (the phonebook copybook) and the web service WSDL file (the phonebook web service WSDL file generated in the Enabling IMS applications as web services sample) in order to generate the converter driver and correlator file.


  • Complete the Enabling IMS applications as web services sample by following the WS-Security disabled scenario.
  • Ensure that you have the Phonebook sample application running as a web service on SOAP Gateway.

Detailed steps are provided in the PDF below.


Document information

More support for:

IMS Enterprise Suite
SOAP Gateway

Software version:


Operating system(s):

Linux, Windows, z/OS

Reference #:


Modified date:


Translate my page

Content navigation