Skip to main content

Software  >  Information Management  >  IMS Family  >  

The synchronous callout function for IMS Version 10

 Product documentation
 
Abstract
This document provides the associated requirements, installation, technical approaches, and monitoring and troubleshooting information or pointers to this information for the synchronous callout function that is made available in IMS™ Version 10 through several APARs. The same functionality is also available in IMS Version 11 for IMS customers who participate in the Version 11 QPP, with two new OTMA enhancements.
 
 
Content
IMS application programs running in IMS Version 10 and IMS Version 11 dependent regions can send outbound messages to request services or data, such as from a Web service, a message-driven bean (MDB), or an Enterprise JavaBeans™ (EJB) component, and receive responses in the same transaction during the same unit of work through IMS Connect and OTMA. The request for services or data outside of the IMS installation is a callout request.

For synchronous callout requests, an IMS application program that runs in an IMS dependent region issues an IMS call (the DL/I ICAL call) and waits in the dependent region to process the response. When the ICAL call is issued, IMS generates a correlation token for synchronous callout requests. This correlation token is included with the callout request and must be returned to IMS with the response to route the response back to the requesting IMS application program.

You can issue a callout request from an IMS application and synchronously receive the response by using any of the following approaches:

  • IMS SOAP Gateway Version 10

    IMS SOAP Gateway enables IMS applications to interoperate outside of the IMS environment through SOAP to provide and request services independent of platforms, environments, application languages, or programming models. For IMS synchronous callout requests, IMS SOAP Gateway handles the correlation of requests and responses for you. IMS SOAP Gateway Version 10 iFix 2 is required.

    See the IMS SOAP Gateway Web site for more product details and download information.

  • IMS TM Resource Adapter Version 10

    The IMS TM resource adapter enables you to easily create Java applications that access new and existing IMS transactions over the Internet, or process IMS callout requests to services or data over the Internet. IMS TM Resource Adapter Version 10.3 is required.

    See the IMS TM resource adapter Web site for more product details and download information.

  • Your own IMS Connect TCP/IP client applications

    You can write your own IMS Connect TCP/IP clientapplications or use a vendor-supplied solution that uses TCP/IP and the IMSConnect protocol to retrieve callout requests. Your custom IMS Connect clientapplication must issue a RESUME TPIPE call to an OTMA routing destination,also known as a transaction pipe (or tpipe), that is defined in an OTMAdestination descriptor. This transaction pipe holds the callout requests.Your custom IMS Connect TCP/IP client application must poll the tpipe toretrieve the callout requests.


 

The IMS synchronous callout function is available in the following APARs.

APAR requirements for IMS Version 10

APARDescription
PK70078, PK73224IMS preconditioning APARs
PK70330IMS Connect preconditioning APARs
PK71135, PK74168Activation APARs
PK75824Synchronous callout IVP sample
PK75209JBP and JMP support for issuing callout requests

Important: Apply this APAR if you are issuing callout requests from Java applications that run in a JBP or JMP region. The JMS interface classes are also required. The interface classes are contained typically in the jms.jar file. You can download the bundle that contains the jms.jar file from http://java.sun.com/products/jms/docs.html, and click Downloadthe version 1.1 API Documentation, Jar and Source.

PK75460The IMS TM resource adapter support for synchronous callout

Important: Apply this APAR if you are using the IMS TM resource adapter for synchronous callout processing.

APAR requirements for IMS Version 11 QPP

APARDescription
PK81543OTMA support for synchronous callout
PK81544IMS Connect support for synchronous callout
Not yet availableSynchronous callout IVP sample
PK85023JBP and JMP support for issuing callout requests

Important: Apply this APAR if you are issuing callout requests from Java applications that run in a JBP or JMP region. The JMS interface classes are also required. The interface classes are contained typically in the jms.jar file. You can download the bundle that contains the jms.jar file from http://java.sun.com/products/jms/docs.html, and click Downloadthe version 1.1 API Documentation, Jar and Source.
IMS TM Resource Adapter support for synchronous callout

Important: Use IMS TM Resource Adapter Version 10.3 for your testing. Download the IMS TM resource adapter from the IMS TM resource adapter Web site.

IMS SOAP Gateway support for synchronous callout

Important: Use IMS SOAP Gateway Version 10.1 with the latest iFix for your testing. Download IMS SOAP Gateway from the IMS SOAP Gateway Web site.

Synchronous callout documentation

The following table lists where you can find more information about the synchronous callout function for IMS Version 10.

Important: For IMS Version 11 QPP customers, before the IMS Version 11 QPP information center is updated in June, the same synchronous callout related content in the IMS Version 10 information center also applies to IMS Version 11. Refer to the Version 11 APAR closing text for additional Version 11 specific information for the two OTMA related enhancements.

TopicsLocation
Function overview, requirements, and installation information
IMS Version 10 Release Planning Guide: IMS callout enhancements
General steps to implement the synchronous callout funtion
IMS Version 10 Application Programming Guide: Callout request for external services or data

IMS Version 10 Communications and Connections Guide: Synchronous callout requests

The new DL/I ICAL call
IMS Version 10 Application Programming Reference: ICAL call

IMS Version 10 Application Programming Reference: CALL statement (support for the ICAL call in the DL/I test program, DFSDDLT0)

IMS Connect support for synchronous callout messages
IMS Version 10 Communications and Connections Guide: IMS Connect support for callout request
OTMA support for synchronous callout messages
IMS Version 10 Communications and Connections Guide: OTMA support for callout requests from IMS application program
IMS SOAP Gateway support for the synchronous callout function
IMS SOAP Gateway Version 10 User's Guide and Reference: Enabling an IMS application as a Web service consumer
IMS TM resource adapter support for the synchronous callout function
IMS TM Resource Adapter User's Guide and Reference: Callout programming models

IMS TM Resource Adapter V10 synchronous and asynchronous callout IVP samples - An end-to-end callout sample using the IMS TM Resource Adapter to process IMS callout requests (with sample files)
Callout samples IVP
IMS Verson 10 Installation Guide: Samples for the callout function
.
 
 
 

Copyright and trademark information
IBM, the IBM logo and ibm.com are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.
Rate this page
Please take a moment to complete this form to help us better serve you.
This material provides me with the information I need.




This material is clear and easy to understand.




Did the information help you to achieve your goal?
What updates, improvements, or related information would you like to see in this document?
Your response will be used to improve our document content. Requests for assistance, if applicable, should be submitted through your normal support channel as we cannot respond from this site.
Input the verification number to submit feedback:
Document information
 Product categories:
 Software
 Data Management
 Data Servers (Database Management Systems)
 IMS
 Transaction Manager
 Operating system(s):
  z/OS
 Software version:
  10.1
 Reference #:
  7014351
 IBM Group:
 Software Group
 Modified date:
 2009-05-29

Translate My Page
 
 

Rate this page

Help us improve this page. Your response will be used to improve our document content. Requests for assistance, if applicable, should be submitted through your normal support channel as we cannot respond from this site.