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 Enterprise
Suite SOAP Gateway runtime environment.
To generate the artifacts that are needed to
enable an existing IMS PL/I application or COBOL application for the IMS Enterprise
Suite SOAP Gateway environment, you must have a PL/I
include file or a COBOL 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 Enterprise Suite SOAP Gateway runtime
environment:
- Open the z/OS Projects
perspective:
- Click the Open Perspective icon. The Open
Perspective window opens.
- In the Open Perspective window, select z/OS Projects.
The z/OS Projects perspective
opens.
- Create a Local Project (Workstation
COBOL or PL/I):
- On the main menu of the workbench, select .
The New Project wizard opens.
- In the New Project wizard:
- Expand Workstation COBOL or PL/I.
- Select Local Project. The New Local Project
wizard opens.
- In the New Local Project wizard, follow the steps to create a
new local project.
- 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:
- In the menu bar of the workbench, select . The Show View wizard opens.
- In the Show View wizard:
- Expand General.
- Select Navigator.
- Click OK.
The Navigator view opens.
- 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
- Start the Enterprise Service Tools Wizard Launchpad from
the Navigator view:
- 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.
- Select Enable Enterprise Web Service.
The Enterprise Service Tools Wizard Launchpad wizard
opens.
- Launch the Create New Service Interface (bottom-up) wizard:
- In the Enterprise Service Tools Wizard Launchpad wizard:
- In the Runtime list box, select IMS Enterprise Suite SOAP Gateway.
- In the Scenario list box, select Create
New Service Interface (bottom-up).
- In the Conversion type list box, select Compiled
XML Conversion.
- Click Start.
The Create New Service Interface (bottom-up) wizard opens.
- On the first page of the wizard (entitled Language
structures):
- 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.
- In the PL/I or COBOL preferences:
- On the General tab:
- Expand the Platform list box and select z/OS.
- Verify or change other entries that apply for your z/OS system.
- Click OK. The Preferences window
closes.
- 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.
- 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.
- Click Next.
- On the second page of the wizard (entitled Generation
Options):
- In the XML Converters tab:
- In the list box Host code page select the
code page that the host uses.
- In the list boxes Request code page and Response code page, select 1208
Unicode, UTF-8.
Note: At this time the IMS Enterprise Suite SOAP Gateway runtime
environment supports only UTF-8.
- In the WSDL and XSD tab:
- In the Service Location (Endpoint URI)
input field, change the host name and port name to the location of
the IMS Enterprise
Suite SOAP Gateway.
Note: This URI specifies the address of the
Web service.
- Verify or change other entries that apply for your z/OS system.
- Click Next.
- On the third page of the wizard (entitled IMS Enterprise Suite SOAP Gateway Service
Provider):
- In the IMS Correlator file tab,
specify any correlator properties that need to be specified for your IMS Enterprise
Suite SOAP Gateway environment. In particular:
- In the input field File container,
specify the folder and subfolder in which you want the correlator
file to be generated.
- Click Next.
- On the fourth page of the wizard (titled File, data
set, or member selection):
- In the XML Converters tab:
- In the input field Converter file container,
specify the folder and subfolder in which you want the converter programs
to be created.
- 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.
- In the WSDL and XSD tab:
- In the input field WSDL file container,
specify the folder and subfolder in which you want the WSDL and XSD
files to be generated.
- Make sure that the check box preceding the input field WSDL
file name is selected.
- In the input field WSDL file name, type
the name of the file in which you want the WSDL document to be created.
- 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.
- 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 Enterprise Suite SOAP Gateway using
the IMS SOAP deployment tool
(see Deploying the Web service files to the IMS Enterprise Suite SOAP Gateway).