The synchronous callout function for IMS Version 11 and 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 11 and IMS Version 10 through several APARs.

Content

IMS application programs running in IMS Version 11 and IMS Version 10 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 Enterprise Suite Version SOAP Gateway

    SOAP Gateway enables IMS applications to inter operate 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, SOAP Gateway handles the correlation of requests and responses for you.

    See the IMS Enterprise Suite SOAP Gateway website for more product details and download information.

  • IMS TM Resource Adapter Version 11.1, Version 10.3, or later

    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 11.1, Version 10.3, or later is required.

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

  • Your own IMS Connect TCP/IP client applications

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


The IMS synchronous callout function is available in the following APARs for IMS Version 10. No APARs are needed for IMS Version 11. The Installation Verification Program (IVP) support to demonstrate the function in IMS Version 11 does require application of additional APARs.

APAR requirements for IMS Version 11

APAR PTF Description
PK97597 UK61338 IMS IVP support for the callout function
PK85023 UK48124 Java support for the DL/I ICAL call
PM29392 UK64387 Synchronous and asynchronous callout IVP sample for IMS TM resource adapter
PM31226 Not available yet Synchronous and asynchronous callout IVP sample for IMS Enterprise Suite SOAP Gateway

APAR requirements for IMS Version 10

APAR PTF Description
PK70078, PK73224 UK40363, UK40813 IMS preconditioning APARs
PK70330 UK40214 IMS Connect preconditioning APARs
PK71135
PK74168
UK42415, UK42416
UK42459
Activation APARs
PK75824 UK43077 Synchronous callout IVP sample
Important: JBP and JMP support for issuing callout requests requires the JMS interface classes. Download the IMS Enterprise Suite JMS API from the IMS Enterprise Suite website.


Synchronous callout documentation

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

Topics Location
General steps to implement the synchronous callout function
IMS Version 11 Application Programming: Callout request for external services or data

IMS Version 11 Communications and Connections: Synchronous callout requests

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

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

IMS Connect support for synchronous callout messages
IMS Version 11 Communications and Connections: IMS Connect support for callout requests
OTMA support for synchronous callout messages
IMS Version 11 Communications and Connections: OTMA support for callout requests from IMS application program
IMS Enterprise Suite SOAP Gateway support for the synchronous callout function
IMS Enterprise Suite SOAP Gateway: Enabling an IMS application as a web service consumer
IMS TM resource adapter support for the synchronous callout function
IMS TM Resource Adapter: Callout programming models

IMS TM Resource Adapter: synchronous and asynchronous callout IVP samples - An end-to-end callout sample using the IMS TM Resource Adapter Version 10.3 or later to process IMS callout requests (with sample files)
Callout samples IVP Not available yet.

The following table lists where you can find more information about the synchronous callout function for IMS Version 10.
Note that IMS Version 10 is out of service, and the links to the IMS Version 10 information point to the IMS Information Center for Out-of-Service Versions.

Topics Location
Function overview, requirements, and installation information
IMS Version 10 Release Planning Guide: IMS callout enhancements
General steps to implement the synchronous callout function
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 Enterprise Suite SOAP Gateway support for the synchronous callout function
IMS Enterprise Suite SOAP Gateway information: 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 Version 10 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 Version 10 Installation Guide: Samples for the callout function

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

IMS
Transaction Manager

Software version:

10.1, 11.1

Operating system(s):

z/OS

Reference #:

7014351

Modified date:

2014-03-31

Translate my page

Machine Translation

Content navigation