Generating web services files from the data mapping files

To enable your IMS application to run as a web service consumer, you must generate web services files from the data mapping session files.

  1. In Rational® Developer for System z®, select both the request message and response message mapping files (hold down the Shift key for multiple selection).
  2. Right-click anywhere in the view that contains the mapping files and select Generate Conversion Code.
    Figure 1. Generating the conversion code from the data mapping files
    This image shows the selection of data mapping files and right-clicking to select the Generate Conversion Code option.
  3. In the Enterprise Service Tools launchpad, select the following values:
    • Host runtime: IMS Enterprise Suite SOAP Gateway
    • Application mode: Web Service Requestor
  4. Click Start.
    The Map to an Existing Service Interface (meet-in-middle) wizard opens.
  5. In the Generation of conversion code page, verify that you have selected the correct mapping session files, and click Next.
    Figure 2. Selecting the request and response mapping files
    This image shows the selection of the request and response mapping files.
  6. In the Generation options page:
    Figure 3. Specifying conversion options
    This image shows the specification of conversion options.
    1. In the XML Converters tab, select or specify the following settings:
      1. Host code page: Select the code page that the host uses.
      2. Inbound code page and outbound code page: Default is 1208 Unicode, UTF-8. SOAP Gateway supports only UTF-8 and therefore you cannot change this value.
    2. Click Next.
  7. Specify properties on the SOAP Gateway Web Service Requestor page:
    1. Specify any service identification properties that need to be specified for your SOAP Gateway environment.
      1. In the File container field, specify the folder and subfolder in which you want the correlator file to be generated.
      2. Specify the IMS Connect interaction properties:
        Figure 4. Specifying correlation properties
        This diagram shows the specification of correlation properties.
        Figure 5. Specifying correlation properties
        This diagram shows the specification of correlation properties.
        • For multiple operations, you must map one operation at a time. Ensure that Update is selected instead of Overwrite so the new operation entry can be added to the correlator file.
        • Transaction code: Specify this value only for a request-response asynchronous web service invocation. That is, a response from the web service for an asynchronous callout request is expected.
        • Inbound connection bundle: Specify this property if a response for the web service is expected.
        • Socket timeout value in milliseconds.
        • Execution timeout value in milliseconds.
        • LTERM name: The logical terminal (LTERM) name that overrides the value in the LTERM field of the IMS application program's I/O PCB. SOAP Gateway places this override name in the IMS application program's I/O PCB so that the program can make logic decisions, based on the override name. The name must be eight characters or less. This property is optional.
        • Callout message type.
        • Web service timeout value in milliseconds.
        • Callout WS-Security. Select the security type.
        Tips:
        • The transaction code value is needed only for responding to an asynchronous callout request. For synchronous callout requests, SOAP Gateway ignores the transaction code even if it is specified. SOAP Gateway handles the correlation of the response with the request by using the correlation token that is attached to the synchronous callout request. For one-way asynchronous callout requests that do not expect a response, the transaction code is also ignored.
        • For the synchronous callout message type, SOAP Gateway does not receive or manage the LLZZ prefix. The data portion of the message contains only data. If you map the LLZZ prefix during data mapping, you must treat LLZZ as data in the callout web service.
        • You can use the SOAP Gateway management utility to modify these correlator properties later if necessary.
    2. Click Next.
  8. On the File, data set, or member selection page of the wizard:
    1. In the XML Converters tab:
      1. For the converter file container, specify the folder and subfolder in which you want the converter file to be created.
      2. For the converter driver file name, specify the name in which you want the converter programs to be generated.
      3. Ensure that the check box Generate all to driver is selected. This selection causes all the generated web service programs (driver, inbound converter, and outbound converter) to be placed in the same file.
      Figure 6. Specifying converter file name and container
      This image shows the specification of converter file name and location.
    2. Click Finish.
The following files are generated in the directories and file names you specified:
  • The correlator file (.xml)
  • The file that contains the web service driver and runtime XML converter (.cbl)
Important: The correlator file that is generated by Rational Developer for System z Version 9.0 or older versions is in a correlator schema older than version 3.0. The correlator file must be migrated to the new correlator scheme:
  1. Store the correlator file in the install_dir/imssoap/xml directory.
  2. Use the SOAP Gateway management utility iogmgmt -migrate correlator command to migrate the correlator file.
Important: Before you run the migration tool, ensure that the calloutConnBundleName property in the version 1.0 correlator schema is not empty. If the calloutConnBundleName property is empty, the migration tool would assume that this correlator is for the web service provider scenario and set the correlator mode value to call-in instead of call-out.