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.
Restriction: This topic applies only when the Enterprise Server feature is enabled.
Restriction: This topic applies to Windows environments only.

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 Team Developer perspective, and appears as a tab on the same level as the Application Explorer view. However, if it is not visible:

  • In Eclipse, click Window > Show View > Other > Micro Focus > Server Explorer, and then click Open.

Create ESSOAP

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

  1. On the Server Explorer, right-click Local [localhost:86]; then 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. Double-click ESTemplate.xml to select it.
    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 Administration

  • From the Eclipse Server Explorer, right-click Local [localhost:86] and then click Open Administration Page.

    The Enterprise Server Administration Home page starts in an Eclipse window.

Configure a listener port

When you create a service interface, 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.

  1. On the Enterprise Server Administration Home page, in the Communications Processes column that corresponds to your enterprise server instance, click the Details button.

    This takes you to the Communications Processes page for Enterprise Server listeners.

  2. Click the Edit button that corresponds to Web Services and J2EE.
  3. Change the contents of the Endpoint Address field to *:9003.
  4. Click OK.

    This returns you to the Communications Processes page.

  5. Click Home at the top of the menu ribbon to return to the Home page.
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.
  2. In the Folder name field, type deploy, and then click Finish.
    Note: To ensure that you can see the deploy folder in COBOL Explorer:
    1. Click View Menu > Customize View .

      This opens the Available Customizations dialog box.

    2. Uncheck Empty folders outside categories.
    3. Click OK.
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 project folder; then select Import > Import from the context menu.
  2. Expand General; then click double-click File System.
  3. Click the Browse button that corresponds to the From directory field, and navigate to the %ProgramFiles(x86)%\Micro Focus\Visual COBOL\deploy folder.
  4. Click Select Folder.
  5. Check .mfdeploy in the right pane.
  6. In the Into folder field, append \deploy to the existing value so that it points to the deploy subdirectory.
  7. Click Finish to import the file into the project.
Define the deployment directory
Now you need to configure your enterprise server instance by defining the new deploy project folder as the deployment folder.
  1. On the Enterprise Server Administration Home page in the Communications Processes column for your enterprise server instance, click the Details button that corresponds to Listeners.
  2. In the row for the Web listener name, click Edit.
  3. Scroll down to the Configuration Information field; then within the 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/workspace/project-name/deploy
  4. Click OK.
  5. Click Home to return to the Home page.