IMS Connect, TMRA and SOAP for IMS Callout - IMS UG June 2013 Sao Paulo

© 2013 IBM Corporation

IMS Connect, TMRA and SOAP Gateway for

IMS Callout

IMS Regional User Group

Sao Paulo, June 6


Acknowledgements and Disclaimers

Availability. References in this presentation to IBM products, programs, or services do not imply that they will be available in all

countries in which IBM operates.

© Copyright IBM Corporation 2013. All rights reserved.

– U.S. Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract

with IBM Corp.

IBM, the IBM logo, ibm.com, IMS, DB2, CICS and WebSphere MQ are trademarks or registered trademarks of International Business

Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first

occurrence in this information with a trademark symbol (® or ™), these symbols indicate U.S. registered or common law trademarks

owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other

countries. A current list of IBM trademarks is available on the Web at “Copyright and trademark information” at

www.ibm.com/legal/copytrade.shtml

Other company, product, or service names may be trademarks or service marks of others.

The workshops, sessions and materials have been prepared by IBM or the session speakers and reflect their own views. They are

provided for informational purposes only, and are neither intended to, nor shall have the effect of being, legal or other guidance or advice

to any participant. While efforts were made to verify the completeness and accuracy of the information contained in this presentation, it is

provided AS-IS without warranty of any kind, express or implied. IBM shall not be responsible for any damages arising out of the use of,

or otherwise related to, this presentation or any other materials. Nothing contained in this presentation is intended to, nor shall have the

effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the

applicable license agreement governing the use of IBM software.

All customer examples described are presented as illustrations of how those customers have used IBM products and the results they may

have achieved. Actual environmental costs and performance characteristics may vary by customer. Nothing contained in these

materials is intended to, nor shall have the effect of, stating or implying that any activities undertaken by you will result in any specific

sales, revenue growth or other results.


IMS Connect


IMS Connect Overview

• Provides high performance TCP/IP and local z/OS®communications between multiple TCP/IP clients and IMS systems

• Supports both IMS DB and IMS TM systems– OTMA through XCF

– ODBM through SCI

IMS Connect

O

T

M

A

IMS DB

IMS

Journaling Journaling

productproduct

Archivejournal

XCF

T

C

P

/

I

P

IMS APP

IMS

Catalog

TCP/IP Clients:-IMS TMRA-IMS SOAP Gateway-IMS Connect API-IMS Universal Drivers

ODBM

SCISCI

SCISCI


IMS Connect Configuration

• No changes are needed in the IMS Connect configuration member HWSCFGxx of the IMS PROCLIB to support IMS Callout

• XML transformations for SOAP Gateway messages– User Message Exit HWSSOAP1

– Add the ADAPTER statement

– Concatenate DSN for XML converters in STEPLIB of the startup JCL


IMS SOAP Gateway


IMS Enterprise Suite SOAP Gateway Overview

• A Light-weight Web Service solution for IMS without the need of a

Java EE server

• Integrates IMS assets into the Service-Oriented Architecture (SOA)

• Provides end-to-end interactions between IMS transactions and web

services clients in an On Demand environment

• Enables IMS as Provider and Consumer of Web Services

• Secure

• Tooling support– Utilizes Rational Developer for System z tooling to create converters for transforming

XML messages to IMS messages and vice versa

– No need to change existing IMS application code (provider scenario)


• Eclipse-based application development tool for modernizing and developing System z applications

– COBOL, PL/I, C, C++, HL Assembler, Java

– Supports IMS, CICS, Batch, USS, etc..

– Interactive access to z/OS system

– Access PDS and run JCL from your workstation

• Premier IBM Integrated Development Environment for development and test of IMS applications

– Drag-and-drop code snippet function for IMS DLI calls

IMS application development and modernization: Rational Developer for System z (RDz)

• Also supports IMS SOA enablement

– Enables CICS and IMS applications for Web

Services and SOA

– Built-in wizard for SOAP Gateway and Web 2.0

– Generate XML COBOL/PLI converters for XML

transformation

– Generate WSDL, correlator files for Web

Services access


ExecutionExecution

GenerationGeneration

<SOAP><LL><ZZ>

<DATA>

SOAP clients

XMLAdapter

AdapterTask

Manager

XMLConverters

IMS Connect

IMS

IMSApp

z/OS

LLZZTRCDDATA

LLZZDATA

TCP/IP

<LL><ZZ><TRCD><DATA>

<LL><ZZ>DATA>

SOAP Gateway

HTTP

SOAP

endpoint

Gateway

connector

SOAP

processor

UDDI

Registry

Java

Client

.NET

Client

HTTP/SOAP

<SOAP><LL><ZZ>

<TRCD><DATA>

RD/z Bottom-Up Wizard

WSDL

CorrelatorFile

Publish

RD/zGenerate

Existing COBOLCopybook

XMLDocument

Log

…/server/logs/imssoap.log

Development Environment

Development environment

Runtime environment

<XMLDocument>

<XMLDocument>

IMS SOAP Gateway Development & Runtime (Provider)


Descriptor name

Timeout

Request Area Length

Response Area Length

Output return codes

ICAL

AIB

IOAreas

COBOL Application with ICAL


OTMA Descriptor

Descriptor name XML ConverterXML Adapter

TPIPE

SOAP Gateway Management Utility

Descriptor and SOAP configuration


IMS

IMS App1

z/OS

z/OS, zLinux, Win, AIX etc..

DL/I ICALDescriptor nameTimeout

IMS Enterprise Suite SOAP Gateway Server

IMS

Connect

Receive Callout Request in XML

Send Callout Response in XML

Web

Service

A

XML

Adapter

Msg1

Msg2

TPIPE

Send ACK

XML

Converter

1

2

3

5

67

Development & Runtime Environment

4

ExecutionExecution

GenerationGeneration

RD/z Meet-In-The-MiddleWizard

Existing WSDL

Correlator

File

RD/zGenerateTask

Existing COBOL

Copybook

Development environment

Error Handling: If Web Services returns a Web Service Fault error, SOAP Gateway sends an error response with the Fault message to the DLI call

Synchronous Callout Flow


Callout with SOAP Gateway – Generate artifacts

• Use Rational Developer for System z (RDz) to generate callout artifacts– Meet-in-the-middle

• Maps WSDL with COBOL data structures

– Generates XML Converters • Runs in IMS Connect

• Converts callout request from bytes to XML and vice versa

– Generates Correlator file• Used by SOAP Gateway to identify which Web Service to invoke at runtime and specify callout

properties

– Deploy WSDL• Contains URL address for the outbound web service


IMS

IMS App1

z/OS

z/OS, zLinux, Win, AIX etc..

:

ISRT ALTPCB

IMSSOAP1

SYNCPT Starts..

IMS Enterprise Suite SOAP Gateway Server

IMS

Connect

IMS App2

Web

Service

A

Initiating

Client

XML

Adapter

Msg1

Msg2

TPIPE

DFSYDTxIMSSOAP1

TYPE = IMSCON

TMEMBER=SM01

TPIPE=TP3

SMEM=Y

ADAPTER = HWSXMLA0

CONVERTR=SOAPIT

Send ACK

SOAP

XML

Converter

Connection

Bundle(CBA)

TPIPE = TP1,TP3

…

1

2

3

4

6

7

8

Runtime Environment

5

Receive Callout Request in XML

Send Callout Response in XML

Asynchronous Callout with Response


IMS Application

Existing

Business Logic

• IMS application sends out a business event data using ISRT ALTPCB call

• RDz generates artifacts to convert IMS business events data to WBE/WBM formats

• SOAP Gateway emits business events data asynchronously to WBM and WBE

Capture

Point

DEST1

EV1

HWS1

Descriptor

IMS Connect

IMS

OTMA

TPIPE

EV1Send Event

WebSphere

Business Events

BytesEvent Action

WebSphere Business

Monitor

SOAP Gateway

XML

Payload SOAP

XML

Adapter

XML

Converter

REST

WebSphere Application Server

WSDL

ISRT ALTPCB

IBM Confidential

Business Event support with SOAP Gateway


Callout with IMS TM Resource Adapter


IMS Transaction Message Resource Adapter (TMRA)

• Deployed in a Java EE 1.4 or later application server

• Used by– Java Applications

– Enterprise Edition applications

– Web Services

• Implements the JEE Connection Architecture (JCA) to manage– Connections

– Transactions

– Security

• Implements JCA Common Client Interface– For your applications to communicate with IMS Transaction Manager


WebSphere and IMS TM Resource Adapter

• Enable IMS transaction as Web Service with full SOA support– Integrate with a variety of Java EE or WebSphere-based servers with built-in

QoS support (2PC, connection pooling, security management)

– Java EE Connector Architecture (JCA/J2C) compliant

– Recommended when Java EE server (e.g. WAS) is already in-use

– Supports rapid application development with Rational tooling

WAS/WPS/WTX/WMB/WESB

IMS TMIMS TM

resourceresource

adapteradapter

WebService

TCP/IP

WebComponent

EnterpriseBean

IMS

Connect

IMS DB *

IMS

IMS App

Rational Application

Developer (RAD) or

WebSphere Integration

Developer (WID)

IMS app

Source

(COBOL, PLI,

C, MFS)

Generates

* Binary, text or XML data


Callout to WebSphere Java EE application using IMS TM

Resource Adapter

• A Java Message-driven bean (MDB) can be written to listen for callout requests from IMS via IMS TM Resource Adapter

• IMS TM Resource Adapter implements the JCA Inbound specificationand deliver callout messages to MDB using standard interfaces

– Hides the low-level IMS Connect and OTMA protocols

– Use Resume Tpipe Auto (with alternate client ID) with Wait-forever

– Handles the correlation token internally

– User specifies the callout properties using the ActivationSpec

– Can process responses from MDBs concurrently

– Auto reconnect to IMS Connect


Synchronous Callout with IMS TM Resource Adapter

• Callout to WAS MDB using IMS TM Resource Adapter

– Support JCA Inbound

– Retrieve Asynchronous callout, Synchronous callout messages as well as

Asynchronous output messages from IMS and deliver to WAS MDB

WebSphere Application Server

IMS

Connect

z/OS

IMSIMS Application

2 ICAL SENDRECV ICODEST1

HELLO FROM IMS

HELLO FROM

WEBSPHERE MDB

TPIPE

ICOPIPE1

Message Driven

Bean (MDB)

Response

1

3

Activate

HELLO FROM IMS

onMessage

HELLO FROM

WEBSPHERE

MDB

IMS

TM

Reso

urc

e A

dap

ter

Initiating Client

ICODEST1ICOTPIPE1HWS1

OTMA Descriptor

Web

Service,

EJB or

MDB

HWS1


public class IMSCalloutIVPMDBBean implements javax.ejb.MessageDrivenBean,

com.ibm.j2ca.base.ExtendedInboundListener {

:

:

public javax.resource.cci.Record onMessage(

javax.resource.cci.Record arg0, javax.resource.cci.InteractionSpec event)

throws javax.resource.ResourceException {

SYNCCALLOUTREQUEST request = new SYNCCALLOUTREQUEST();

SYNCCALLOUTRESPONSE response = new SYNCCALLOUTRESPONSE();

// Request

request.setBytes(((IMSInputStreamRecord)event).getBytes());

System.out.println("Synchronous callout request from IMS: " +

request.getSync__callout__request__str());

// Response

response.setSync__callout__response__str("HELLO FROM WEBSPHERE MDB");

System.out.println("Synchronous callout response from WAS MDB: " +

response.getSync__callout__response__str());

return response;

}

}

Callout with IMS TM RA – Sample MDB code


TPIPEName

IMS Connect connection info and Datastore

name

Callout with IMS TM RA – Deploy the RAR/Configure ActivationSpec


Callout with IMS TM RA – Deploy the MDB


Thank You!

Technology

IMS Connect, TMRA and SOAP for IMS Callout - IMS UG June 2013 Sao Paulo