IMS Enterprise Suite SOAP Gateway project

Edit online

This topic describes scenarios typical for the IMS Enterprise Suite SOAP Gateway project

The IMS Enterprise Suite SOAP Gateway is a lightweight Web service solution that enables IMS applications to interoperate outside of the IMS environment through SOAP to provide and request services independently of platform, environment, application language, or programming model. You can enable IMS COBOL and PL/I applications for Web services by using the Enterprise Service Tools to generate Web service artifacts for IMS COBOL and PL/I applications. You then deploy these Web service artifacts to the IMS Enterprise Suite SOAP Gateway to make an IMS application available as a Web service. Different types of client applications, such as Microsoft.NET, Java™ and third-party applications, can then submit SOAP requests into IMS to drive the business logic of the COBOL and PL/I applications.

The following scenarios are supported:
  • Scenario: Create New Service Interface (bottom-up)

    Generate a Web service description and runtime-specific XML message processing from a high level language structure. You can use this option when you expose an application program as a service provider.

    Generated artifacts (Compiled XML Conversion)

    • IMS Enterprise Suite SOAP Gateway Driver Program
    • IMS SOAP Request XML Converter
    • IMS SOAP Response XML Converter
    • IMS Correlator (runtime metadata)
    • WSDL document
    • Request XSD
    • Response XSD

  • Scenario: Map to an Existing Service Interface (meet-in-middle)

    Define mappings between high level language structures and WSDL, XML, or XSD You can use this option to generate XML message processing based on the mappings. You can use the Create Mappings wizard to define the mappings and create compiled converters. Selecting Map an Existing Service Interface takes you to a wizard where you select the source and target for the mapping. After you select the source and target of the mapping, the single-service mapping editor opens.

    Generated artifacts (Compiled XML Conversion)

    • XML to COBOL or PL/I mapping (request message)
      • IMS SOAP Driver Program
      • IMS SOAP Request XML Converter
      • IMS Correlator (runtime metadata)
    • COBOL or PL/I to XML (response message)
      • IMS SOAP Driver Program
      • IMS SOAP Response XML Converter
      • IMS Correlator (runtime metadata)

  • Scenario: Create New Service Implementation (top-down) IMS Enterprise Suite SOAP Gateway with Compiled Conversion and Enterprise PL/I language only
    Note: Currently this scenario is supported only in the batch processor (see Batch processor).

    WSDL2PLI scenario: This scenario is referred to as the WSDL2PLI (WSDL to PL/I) scenario.

    In this scenario a new IMS Enterprise Suite SOAP Gateway Web service provider program supporting one or more operations is created from the information in a WSDL file.

    Single-service tools APIs are also provided to handle the transmission and receipt of SOAP language structures on the IMS Message Queue or in IMS Connect.

    Generated artifacts (see Output files generated in the WSDL2PLI scenario):

    • IMS Enterprise Suite SOAP Gateway Driver program supporting multiple operations
    • For each operation:
      • Request language structure
      • Response language structure
      • IMS Connect Request Converter
      • IMS Connect Response Converter
    • Multi-operation, multi-converter IMS Correlator file (runtime metadata)
    Components:
    • The single-service component that does common processing for this scenario is WSDL2ELS (WSDL to Enterprise Language structure).
    • The single-service component that does PL/I-specific processing for this scenario is WSDL2PLI (WSDL to PL/I).

Related concepts

Supported runtime environments

Related reference

SOAP for CICS project
Batch, TSO, z/OS UNIX System Services project