CICS Transaction Server for z/OS 5.5 Using Web Services with CICS IBM Note Before using this information and the product it supports, read the information in “Notices” on page 635. This edition applies to the IBM® CICS® Transaction Server for z/OS® Version 5 Release 5 (product number 5655-Y04) and to all subsequent releases and modifications until otherwise indicated in new editions. © Copyright International Business Machines Corporation 1974, 2020. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents About this PDF.....................................................................................................vii Chapter 1. CICS and web services..........................................................................1 CICS and SOAP web services ......................................................................................................................3 Message handlers and pipelines............................................................................................................4 SOAP nodes.......................................................................................................................................... 12 SOAP messages and the application data structure........................................................................... 12 WSDL and the application data structure............................................................................................15 WSDL and message exchange patterns...............................................................................................16 The web service binding file.................................................................................................................17 SOAP architecture and message format..............................................................................................18 Planning to use SOAP web services.....................................................................................................26 CICS and JSON web services.................................................................................................................... 27 Concepts of JSON web services.......................................................................................................... 28 Concepts of RESTful JSON web services.............................................................................................30 Planning to use JSON web services.....................................................................................................31 CICS and z/OS Connect............................................................................................................................. 33 Capabilities of z/OS Connect for CICS................................................................................................. 37 Chapter 2. Configuring web services in CICS........................................................ 39 Configuring your CICS system for web services....................................................................................... 39 CICS resources for web services......................................................................................................... 39 Configuring CICS to use the IBM MQ transport...................................................................................42 Interoperability between the web services assistant and WSRR....................................................... 49 Creating the web services infrastructure.................................................................................................. 50 The web services infrastructure.......................................................................................................... 50 Creating the CICS infrastructure for a SOAP service provider............................................................ 59 Creating the CICS infrastructure for a SOAP service requester..........................................................61 Creating the CICS infrastructure for a JSON service provider............................................................ 62 Creating the CICS infrastructure for a non-Java JSON service provider............................................ 63 Configuring z/OS Connect for CICS......................................................................................................64 Pipeline configuration files...................................................................................................................79 Application handlers.......................................................................................................................... 124 Message handlers.............................................................................................................................. 126 The SOAP message handlers.............................................................................................................133 Containers used in the pipeline......................................................................................................... 137 Runtime processing for web services................................................................................................162 Support for Web Services transactions............................................................................................. 170 Support for MTOM/XOP optimization of binary data.........................................................................177 Support for Web Services Addressing............................................................................................... 185 Support for SAML............................................................................................................................... 203 Chapter 3. Developing web services................................................................... 205 Creating a JSON web service.................................................................................................................. 205 The CICS JSON assistant .................................................................................................................. 205 Creating a JSON service provider application...................................................................................242 JSON web service restrictions...........................................................................................................255 Mapping and transforming application data and XML............................................................................257 The CICS XML assistant .................................................................................................................... 257 Generating mappings from language structures...............................................................................365 iii Generating mappings from an XML schema......................................................................................367 Transforming application data to XML...............................................................................................368 Transforming XML to application data...............................................................................................369 Mapping and transforming application data and JSON..........................................................................370 The CICS JSON assistant .................................................................................................................. 371 Generating mappings from language structure................................................................................ 443 Generating mappings from a JSON schema......................................................................................445 Transforming application data to JSON by linking to DFHJSON.......................................................446 Transforming application data to JSON by using the TRANSFORM DATATOJSON API command...447 Transforming JSON to application data by linking to DFHJSON.......................................................448 Transforming JSON to application data by using the TRANSFORM JSONTODATA API command...448 Creating a JSON web service client application................................................................................449 Creating a SOAP web service.................................................................................................................. 450 The CICS web services assistant ...................................................................................................... 451 Creating a web service provider using the assistant.............................................................................. 538 Creating a service provider application from a web service description..........................................538 Creating a service provider application from a data structure .........................................................540 Creating a channel description document........................................................................................ 543 Customizing generated web service description documents........................................................... 544 Sending a SOAP fault......................................................................................................................... 546 Creating a web service requester using the assistant............................................................................ 547 Creating a web service using tooling.......................................................................................................549