Tutorial: OpenESQL Assistant

Guides you through the process of using the OpenESQL Assistant to generate SQL queries and a COBOL application to contain them.

In this tutorial, you create an application using OpenESQL Assistant to generate a skeleton COBOL program, an SQL query to embed into that program, and to generate and embed an INCLUDE statement for a generated copybook that defines host variables. It also takes you through the process of customizing the program code, and debugging the resulting application.

Assumptions

This tutorial is written from the perspective that all of the following is true. Specific instructions for setting up your environment to adhere to these assumptions is found in the Before you begin this tutorial section that follows:

  • Windows File Explorer is set to show file names and extensions.
  • You are running the latest version of Visual COBOL, which has been installed on your local machine using default installation settings.
  • You have installed and can access a supported version of Microsoft SQL Server.
  • Visual COBOL is started on your local machine, and the appropriate Perspective and View are open..
  • Eclipse options are set to build projects automatically.
  • Eclipse Enterprise Server preferences have been set to automatically start and stop the associated enterprise server region when debugging, and dynamic debugging is enabled.
  • You have addressed all of the items in the Before you begin this tutorial section below.

Before you begin this tutorial

Install Microsoft SQL Server
To complete this tutorial, you must have Microsoft SQL Server, including the SQL Server Management Studio, installed and configured on your machine. For information on current supported versions, see the OpenESQL section of the Database Management Systems (DBMSs) topic.
Set Windows File Explorer options
These tutorials assume that your Windows File Explorer options are set to use the Details layout, and to show file name extensions. See your Windows documentation for more information.
Start Visual COBOL
Start Visual COBOL using the default workspace, which is %USERPROFILE%\eclipse-workspace. If you need instructions to get Visual COBOL started on your local machine, see To start Visual COBOL.
Note: If Visual Studio prompts you on startup to select an initial action, click Continue without code.
Open the COBOL Perspective and COBOL Explorer View in Eclipse
When you start Visual COBOL for the first time, the COBOL perspective starts automatically by default, and shows the COBOL Explorer view. If this is not the case, open the COBOL perspective as follows:
  1. From the Eclipse IDE, click Open Perspective Open Perspective.
  2. On the Open Perspective dialog box, select COBOL, and then click Open.
Set Eclipse to build automatically
By default, the Eclipse Build Automatically option is turned on, which means that Eclipse builds a project automatically each time a change is made. To ensure that this Build Automatically is turned on:
  1. From the Eclipse Main Menu, click Project.
  2. Do one of the following:
    • If the Build Automatically menu option has a check mark to its left, it is already turned on. No further action is required.
    • If the Build Automatically menu option does not have a check mark to its left, click the option to turn it on.
Set Enterprise Server debug options
  1. From the Eclipse main menu, click Window > Preferences.
  2. In the left pane, expand Micro Focus, and click Enterprise Server.
  3. Set the following options to Always, and then click Apply and Close:
    • Automatically start the associated server
    • Automatically stop servers started by Eclipse when closing Eclipse
    • Automatically enable dynamic debugging

Sequence

To complete this tutorial, progress through these topics in the order presented here. The bottom of each topic provides Next topic and Previous topic navigational links to help you proceed in the proper sequence:

  1. Create the OESQLDemo SQL Server Database
    Provides instructions for using Microsoft SQL Server Management Studio to create a SQL Server database to use in this tutorial, and to create the required schemas and tables.
  2. Set Up the OESQLAsst Project
    Walks you through the steps required to create and configure an Eclipse project to use for this tutorial.
  3. Set the OpenESQL Assistant Type COBOL Variable
    Provides the steps required to set configuration options for the OpenESQL Assistant.
  4. Catalog the OESQLDemo Connection as an ODBC Data Source
    Guides you through the process of cataloging the OESQLDemo connection as an ODBC data source.
  5. Define and Test a Query
    Provides step-by-step instructions for using the OpenESQL Assistant to define and test an SQL query.
  6. Generate and Embed an SQL Program and Query
    Walks you through the process of using the OpenESQL Assistant to generate a generic COBOL SQL program, embedding the program into an existing COBOL program in the OESQLAsst project, and adding the generated SQL query to the program.
  7. Generate and INCLUDE the EMP.cpy Copybook
    Walks you through the steps required to use the OpenESQL Assistant to generate copybook that contains the table declaration and appropriate data structures, and an EXEC SQL INCLUDE statement to call the copybook from the program.
  8. Debug the SQL COBOL Application
    Guides you through the process of setting a break point, and debugging the application in Eclipse.
Parent topic: Native COBOL Tutorials
Related concepts
OpenESQL Assistant
Related tasks
To start Visual COBOL