Rational Developer for System z, Version 7.6

Generating service interface files from the IMS application

Use the Enterprise Service Tools to generate the artifacts that are needed to enable your existing IMS PL/I application or COBOL application to run as a Web service in the IMS™ SOAP Gateway environment.
To generate the artifacts that are needed to enable an existing IMS PL/I application orCOBOL application for the IMS SOAP Gateway, you must have a PL/I include file or aCOBOL copybook that describes the format of the input and output messages for the IMS application.

Because artifacts generated by the Enterprise Service Tools wizard (the WSDL file, the correlator file, and either PL/I include file or the COBOL copybook file containing the Web service driver and the runtime XML conversion programs) must be transferred to a z/OS® system, you can use the z/OS Projects perspective and a Local Project in the IBM® Rational® Developer for System z® to assist with this task.

To generate Web services artifacts for the IMS SOAP Gateway:
  1. Open the z/OS Projects perspective:
    1. Click the Open Perspective icon. The Open Perspective window opens.
    2. In the Open Perspective window, select z/OS Projects. The z/OS Projects perspective opens.
  2. Create a Local Project (Workstation COBOL or PL/I):
    1. On the main menu of the workbench, select File > New > Project. The New Project wizard opens.
    2. In the New Project wizard:
      1. Expand Workstation COBOL or PL/I.
      2. Select Local Project. The New Local Project wizard opens.
    3. In the New Local Project wizard, follow the steps to create a new local project.
  3. Verify that the Navigator view is open in the z/OS Projects perspective; a Navigator tab should be visible on the interface. If the Navigator view is not open, follow these steps to open the Navigator view:
    1. In the menu bar of the workbench, select Window > Show View > Other. The Show View wizard opens.
    2. In the Show View wizard:
      1. Expand General.
      2. Select Navigator.
      3. Click OK.
    The Navigator view opens.
  4. Import into your local project the file (either the PL/I include file or the COBOL copybook file), that contains the data structures which describe the input and output data structures of your IMS application. The imported file should also be visible in the Navigator view.
    The files that can be used to import into your local project are:
    • COBOL:.cbl, .cpy, .cob, and .ccp
    • PL/I: .pli, .inc, and .mac
  5. Start the Enterprise Service Tools Wizard Launchpad from the Navigator view:
    Note: The following steps are only for the Create New Service (bottom-up) wizard, see Overview of the contexts for opening the launchpad when you run the wizard outside the Enterprise Tools Perspective for additional information.
    1. In the Navigator view, right-click the imported source file (PL/I or COBOL) that contains the input and output data structures of the IMS application.
    2. Select Enable Enterprise Web Service.
    The Enterprise Service Tools Wizard Launchpad wizard opens.
  6. Launch the Create New Service Interface (bottom-up) wizard:
    1. In the Enterprise Service Tools Wizard Launchpad wizard:
      1. In the Runtime list box, select IMS SOAP Gateway.
      2. In the Scenario list box, select Create New Service Interface (bottom-up).
      3. In the Conversion type list box, select Compiled XML Conversion.
      4. Click Start.
      The Create New Service Interface (bottom-up) wizard opens.
  7. On the first page of the wizard (entitled Language structures):
    1. Click the button Change PL/I Preferences or Change COBOL Preferences. The Preferences window opens and displays the PL/I or COBOL preferences in the right pane.
    2. In the PL/I or COBOL preferences:
      1. On the General tab:
        1. Expand the Platform list box and select z/OS.
        2. Verify or change other entries that apply for your z/OS system.
      2. Click OK. The Preferences window closes.
    3. In the Request Language Structure tab, select the high-level language structure (PL/I or COBOL) that is the input structure for your IMS application. By default, the first structure defined in the program source file is selected.
    4. In the Response Language Structure tab, select the high-level language structure (PL/I or COBOL) that is the input structure for your IMS application. By default, the first structure defined in the program source file is selected.
    5. Click Next.
  8. On the second page of the wizard (entitled Generation Options):
    1. In the XML Converters tab:
      1. In the list box Host code page select the code page that the host uses.
      2. In the list boxes Request code page and Response code page, select 1208 Unicode, UTF-8.
        Note: At this time the IMS SOAP Gateway runtime environment supports only UTF-8.
    2. In the WSDL and XSD tab:
      1. In the Service Location (Endpoint URI) input field, change the host name and port name to the location of the IMS SOAP Gateway.
        Note: This URI specifies the address of the Web service.
      2. Verify or change other entries that apply for your z/OS system.
    3. Click Next.
  9. On the third page of the wizard (entitled IMS SOAP Gateway Service Provider):
    1. In the IMS Correlator file tab, specify any correlator properties that need to be specified for your IMS SOAP Gateway environment. In particular:
      1. In the input field File container, specify the folder and subfolder in which you want the correlator file to be generated.
      Note: You can generate artifacts directly to the z/OS UNIX® System Services file system (see Generating artifacts remotely).
    2. Click Next.
  10. On the fourth page of the wizard (titled File, data set, or member selection):
    1. In the XML Converters tab:
      1. In the input field Converter file container, specify the folder and subfolder in which you want the converter programs to be created.
      2. In the input field Converter driver file name, type the name of the file in which you want the converter programs to be generated.
        Note: Make sure that the check box Generate all to driver is selected. This causes all the generated Web service programs (driver, request converter, and response converter) to be placed in the same file.
        Note: You can generate artifacts directly to MVS (see Generating artifacts remotely).
    2. In the WSDL and XSD tab:
      1. In the input field WSDL file container, specify the folder and subfolder in which you want the WSDL and XSD files to be generated.
      2. Make sure that the check box preceding the input field WSDL file name is selected.
      3. In the input field WSDL file name, type the name of the file in which you want the WSDL document to be created.
      4. Clear the check boxes preceding the input fields Request XSD file name and Response XSD file name.
        Note: The XSD files are not required by IMS SOAP Access. However, as an option, you can select these two check boxes to cause the two XSD files to be generated.
        Note: You can generate artifacts directly to the z/OS UNIX System Services file system (see Generating artifacts remotely).
    3. Click Finish.

The following files are generated:
  • The WSDL file (.wsdl).
  • The correlator file (.xml).
  • The file containing the Web service driver and runtime XML conversion programs (.cbl).
  • The request and response XSD files (.xsd).

After you create the service interface files, the next step is to deploy the service interface files to the IMS SOAP Gateway using the IMS SOAP deployment utility (see Deploying the Web service files to the IMS SOAP Gateway).


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)