Set Up the ESSOAP Enterprise Server Instance

Walks you through the process of creating and configuring the ESSOAP enterprise server instance used to run the MakeCheckAppt SOAP Web service.

To successfully deploy and run (debug) a Web Service, you must have an enterprise server instance started in Enterprise Server. For this tutorial, you create and configure the ESSOAP enterprise server instance.

Start the Server Explorer

The Server Explorer view is visible by default when using the COBOL perspective, and appears as a tab on the same level as the COBOL Explorer view. However, if it is not visible:

  • In Eclipse, click Window > Show View > Other > Micro Focus > Server Explorer, and then click Open.
Attention: You might encounter an ESCWA Sign On dialog box as you perform the steps required to create, configure, start, or stop an enterprise server region from the Server Explorer. If you do, ensure that the Server requires credentials, Use specific server credentials, or Server is secured , and the Store credentials boxes are unchecked, and then click OK. Also, if prompted to disable password recovery, click No.

Create ESSOAP

In this section, you create the ESSOAP enterprise server instance from the Server Explorer in Visual COBOL.

  1. On the Server Explorer, expand Local [localhost:10086]; then right-click Default [127:0.0.1:86] and select New > Enterprise Server .
  2. In the Name field, type ESSOAP.
  3. Click the Browse button associated with the Template field.

    The default location for Enterprise Server templates is %ProgramFiles(x86)%\Micro Focus\Visual COBOL\etc\ServerTemplates.

  4. Click ESTemplate.xml to select it, and then click Open.
    Note: If the Template field does not show the path and ESTemplate.xml file, browse to the Enterprise Server template location cited above to find and select the file.
  5. Click Finish.

Start Enterprise Server Common Web Administration (ESCWA)

  • From the Eclipse Server Explorer, right-click the Local [localhost:10086] node, and then select Open Administration Page from the context menu.

    ESCWA starts in your default browser.

Configure listener ports in ESCWA

When you create a service interface in Visual COBOL, it is configured by default to use port number 9003 to send messages to Enterprise Server, which listens for incoming messages on its Web Services and J2EE listener. You need to set the endpoint address for the Web Services and J2EE listener to match the port number for the service interface.

In addition, you need to enable the Web listener to start automatically with the enterprise server instance.

  1. In ESCWA, click Native.
  2. In the navigation pane, expand Directory Servers > Default, and select your enterprise server instance.
  3. On the General drop-down list, select Listeners.
  4. In the Listeners section, notice the Web Services and J2EE one.
  5. Click Edit (Edit) on the row for this listener.
  6. In the Port field, type 9003.
  7. Scroll down to the Status section, and set Requested Status to Stopped, if not set to this already.
  8. Click Apply.
  9. In the Native Listener Navigation pane on the left, click Web under Communications Process 1.
  10. Change the value of the Requested Status field to Stopped.
  11. Click Apply.
Important: The default deployment directory used by Enterprise Server is a subdirectory, deploy, within your Visual COBOL installation directory structure. If you have Administrator privileges to this subdirectory, or if you started Eclipse using Run as Administrator, you are not required to complete the following tasks. Otherwise, you must complete them to create and configure an alternative deployment directory.

Create and configure a deployment directory

Create the deploy directory
Without Administrator privileges, you cannot deploy to Enterprise Server from the default Visual COBOL deployment folder. To ensure successful deployment, create a deploy subdirectory in your project.
  1. In the COBOL Explorer, right-click the project, and then select New > Folder from the context menu.
    Note: If Folder is not an option on the context menu, click Other, and create a new deploy folder from there.
  2. In the Folder name field, type deploy, and then click Finish.
Import the .mfdeploy file
The new deploy folder must contain the .mfdeploy configuration file. You import the file from the COBOL Explorer.
  1. From the COBOL Explorer, right-click the new deploy folder, and then select Import > Import from the context menu.
  2. Expand General, and then click double-click File System.
  3. Click the Browse button that corresponds to the From directory field, and browse to the %ProgramFiles(x86)%\Micro Focus\Visual COBOL\deploy folder.
  4. Click Select Folder.
  5. Check .mfdeploy in the right pane.
  6. Click Finish to import the file into the project.
Define the deployment directory in ESCWA
Now you need to configure your enterprise server region by defining the new deploy project folder as the deployment folder.
  1. In ESCWA ensure that your enterprise server region is selected in the navigation pane, and the Communications Processes page is open in the right pane.
  2. Under Communications Process 1 in the lower left pane, select Web.
  3. In the Listener Properties pane, scroll down to the Custom Configuration field.
  4. Within the Custom Configuration field, scroll down until you find the relevant code, then change:
    uploads=<ES>/deploy

    to:

    uploads=project-folder/deploy

    where project-folder is the full path to your project folder, using forward slashes to separate subfolders. For example:

    uploads=c:/Users/Bob/eclipse-workspace/project-name/deploy

    where project-name is the name of the project.

  5. Click Apply.