Calling COBOL on z/VSE Batch from Integration Server

This document covers the following topics:

This scenario uses the EntireX Workbench tools IDL Extractor for COBOL and Integration Server Wrapper of the Software AG Designer.


Introduction

Under z/VSE batch, a COBOL server with a standard call interface can be called.

graphics/vse-batch-solution.png

graphics/blue_1.gif Extract the interface of the COBOL server program.
graphics/blue_2.gif Generate connection and adapter services in Integration Server.
graphics/blue_3.gif Execute the call from Integration Server to the COBOL server program.

This scenario makes the following important assumptions:

For Task 1:

  • You have a working COBOL batch server. For illustration and examples on such a server, see Batch with Standard Linkage Calling Convention.

  • You have access to the related COBOL sources and copybooks as files on your local machine. The minimum requirement is the DATA DIVISION of the interface.

For Tasks 2 and 3:

  • You have an Integration Server with EntireX Adapter installed.

  • You can call the COBOL server program at runtime using different methods:

Task 1: Extract the Interface of a COBOL Server

Follow the instructions for extracting COBOL, see Using the IDL Extractor for COBOL - Overview and choose Scenario I: Create New IDL and Server Mapping Files if this is your first extraction.

If you have not yet set the type of COBOL mapping for the Workbench (Eclipse workspace), you are asked to set this first. We recommend using client-side mapping if you are new to EntireX.

graphics/cob2is_common_extract.png

Start of instruction setTo extract the COBOL server

  1. Set the correct interface type in Step 4: Define the Extraction Settings and Start Extraction under Scenario I: Create New IDL and Server Mapping Files in the IDL Extractor for COBOL documentation.

    graphics/vse-batch_extract.png

  2. Continue with specific information on this interface type, Batch with Standard Linkage Calling Convention.

    This process creates the following EntireX metafiles:

    • IDL file. A Software AG IDL file contains definitions of the interface between client and server. See Software AG IDL File in the IDL Editor documentation.

    • Server mapping file (optional). The mapping file is an EntireX Workbench file with extension .svm or .cvm that contains COBOL-specific mapping information. See Server Mapping Files for COBOL in the EntireX Workbench documentation.

Start of instruction setTo test the extraction results (optional)

  1. You can test the results of the extraction operation and the COBOL Server back end, using the EntireX IDL Tester. From the context menu of the IDL file in the EntireX Workbench, choose Software AG IDL Tester.

    graphics/common_test-select.png

  2. Select "getDetailsOfEmployee".

    graphics/common_test-idlTester.png

    Note that the Broker and Server parameters contain the explicit route to call the server program, and you can optionally ping the connection from this client. See EntireX IDL Tester in the EntireX Workbench documentation.

  3. Check the Integration Server log, the EntireX Adapter log or the RPC logs.

Task 2: Generate the Connection and Adapter Services in Integration Server

This section describes your first steps to create a new Integration Server connection. This is described in more detail under Using the Integration Server Wrapper, for example working with existing Integration Server connections. This section covers the following topics:

Step 1: Start the Integration Server Wrapper Wizard

Start of instruction setTo start the Integration Server Wrapper wizard

  1. In the context menu of a Software AG IDL file, choose Integration Server > Generate webMethods IS Connection.

    This starts the wizard with a list of existing Integration Server Wrapper connections.

    Note:
    If the selected IDL file is not valid because of a syntax error, an error dialog comes up and the wizard does not start.

  2. Continue with Step 2: Create a New Integration Server Connection.

Step 2: Create a New Integration Server Connection

graphics/using_createNew.png

Start of instruction setTo create a new Integration Server connection

  1. Define the new Integration Server connection on the wizard page.

    Notes:

    1. The only required field is Server. Enter the hostname of the Integration Server including an optional port number. If no port number is specified, port number defaults to "5555". The Integration Server Authentication can be passed with the User and Password fields.
    2. Optional settings are for secure connections. The Truststore for HTTPS contains all signed certificates and must be a valid truststore.
    3. The check box Verify host name checks that the hostname is entered in the stored certificate.
    4. When the Integration Server has Client Authentication enabled, you can specify your Keystore file and keystore Password.
    5. For managing Integration Server connections, see Integration Server Preferences in the Integration Server Wrapper documentation.
  2. Choose Next and continue with Step 3: Select the Connection Type.

Step 3: Select the Connection Type

graphics/using_connectionType.png

Start of instruction setTo create a new connection

  1. Select a connection type from the drop down list. Connection types are described under EntireX Adapter Connections in the EntireX Adapter documentation and Introduction to the Integration Server Wrapper.

    Note:
    The list of connection types is filtered: connection types that require a license are only shown if a corresponding license file is available. Reliable RPC connections are only shown if all IDL programs contain only IN parameters. Also, if a server mapping file is available, only those connection types that support the interface type specified in the server mapping file are shown.

  2. Click Next and continue with Step 4: Define Adapter Services for an RPC Connection.

Step 4: Define Adapter Services for an RPC Connection

graphics/using_define-rpc.png

Start of instruction setTo create a connection and related adapter services

  1. Select a package for the created objects.

  2. Define a folder name. If the folder does not exist, it will be created.

  3. Define a connection name.

  4. Define the parameters of the connection type. For details, see the EntireX and your webMethods Integration Server Applications.

    As a result, the folder will contain the connection and the adapter services (one for each IDL program). The name of a service is the same as the respective IDL program.

The default settings for new RPC adapter services are:

  • the Default package; if not available, the first package

  • the IDL library name for the Folder Name

  • the IDL library name with the suffix "Connection" for the Connection Name

Note:
When creating a connection, a package dependency is added such that the selected package depends on webMethods EntireX (the package WmEntireX) with the version currently used.

Task 3: Execute the Call from Integration Server to COBOL

From the Service Development perspective, refresh the package where the connection service was written, select the adapter service and use the service test to Run Service. This invokes the adapter service through the connector service.

graphics/nat2is_test-1.png

graphics/nat2is_test-2.png

In case of error or unexpected results:

  • Check the Integration Server log, the EntireX Adapter log or the RPC logs.

  • Use the IDL Tester as described under Step 1 above.