Create and Configure ESSOAP

Walks you through the process of creating and configuring an enterprise server instance, ESSOAP, to use in this tutorial.
Restriction: This topic applies only when the Enterprise Server feature is enabled.

To successfully deploy and run (debug) a Web Services service interface, you must have an enterprise server instance started in Enterprise Server. For these tutorials, you create and configure the ESSOAP enterprise server instance.

Create ESSOAP

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

  1. If the Server Explorer is not loaded, click View > Server Explorer.
  2. On the Server Explorer, expand Micro Focus Servers; then right-click localhost and select New Enterprise Server.
  3. In the Name field, type ESSOAP.
  4. Click the browse button associated with the Template field.

    The default location for Enterprise Server templates is VSInstallDir\Common7\IDE\Extensions\Micro Focus\Visual COBOL SOA\1.0\Etc\ServerTemplates, where VSInstallDir is your Visual Studio installation directory.

  5. Double-click ESTemplate.xml to select it.
    Note: If the Template field does not show the path and ESTemplate.xml file, browse to the default location for Enterprise Server templates to find and select the file.
  6. Check the box next to ProgramSOAP to associate the project with the new enterprise server instance.
  7. Click OK.

Start Enterprise Server Administration

  1. From the Server Explorer, right-click Micro Focus Servers; then click Administration.

    The Enterprise Server Administration Home page starts in a Visual COBOL integrated browser.

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 for the ESSOAP server, 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 Listener.
  3. Change the contents of the Endpoint Address field to *:9003.
  4. Click OK.

    This returns you to the Communications Processes page.

  5. Click the Edit button that corresponds to Web listener.
  6. Change the value of the New Status field to Stopped. This enables the listener used to deploy the service interface to the ESSOAP server.
  7. Click OK.
  8. Click Home to return to the Home page.
    Important: If you do not have Administrator privileges to the Visual COBOL installation directory, continue with the configuration. Otherwise, configuration for the ESSOAP enterprise server instance is complete at this point.

Create and Configure a Deployment Folder

Note: The default deployment folder used by Enterprise Server is a subfolder to your Visual COBOL installation folder. If you have Administrator privileges to the Visual COBOL installation structure, or if you started Visual COBOL using Run as Administrator, you are not required to complete this section of the tutorial. Otherwise, you must complete this section to create and configure an alternative deployment folder.
Create the deploy folder
Without Administrator privileges, you cannot deploy to Enterprise Server from the default Visual COBOL deployment folder. To ensure successful deployment, create a deploy folder in your ProgramSOAP project.
  1. In the Solution Explorer, right-click the project; then select Add > New Folder from the context menu.
  2. Type deploy; then press Enter.
Import the .mfdeploy File
The new deploy folder must contain the .mfdeploy configuration file. You import the file from the Solution Explorer.
  1. From the Solution Explorer, right-click the deploy folder; then select Add > Existing Item.
  2. Browse to the InstallFolder\deploy folder where InstallFolder is your Visual COBOL installation folder. By default, this is %ProgramFiles(x86)%\Micro Focus\Visual COBOL.
  3. Double-click the .mfdeploy file.
Define the Deployment Folder
Now you need to configure the ESSOAP 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. Click the Listeners tab.
  3. In the row for the Web listener name, click Edit.
  4. 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=ProjectFolder/deploy
    where ProjectFolder is the full path to your project folder, using forward slashes to separate subfolders. For example: 
    uploads=c:/tutorials/solution-name/project-name/deploy
  5. Click OK.
  6. Click Home to return to the Home page.
Parent topic: Tutorial: SOAP Service Interface
Previous topic: Define Service Interface Operations
Next topic: Deploy a Service Interface