Previous Topic Next topic Print topic


Deploy a Service Interface

Walks you through the steps required to associate an enterprise server instance with your project, build the project, set deployment properties, deploy the service interface, and verify the deployment results.
Restriction: This topic applies only when the Enterprise Server feature is enabled.
Restriction: This topic applies to Windows environments (local development) only.

To successfully deploy a SOAP service interface to an enterprise server instance, you need to first set some options in Visual COBOL.

Set Deployment Properties

To ensure that the deployment process runs smoothly, you must set some options that tell Visual COBOL the name of your enterprise server instance, and where to find certain files.

  1. From the COBOL Explorer, expand ProgramSOAP > Web Services
  2. Right-click the ProgramSOAP Web service; then select Properties from the context menu.
  3. On the Deployment Server tab, click the Change button that corresponds to the Enterprise Server name field.
  4. In the Server column, click ESSOAP; then click OK.
  5. On the Application Files tab, click Legacy application needs deploying; then click Add Files to add the following files:
    Files Location Description
    • appoint.dat
    • consultants.dat
    • customers.dat

    Your project's ProgramSOAP folder

    Data files accessed by the service.
    schedule.dll Your project's New_Configuration.bin folder The executable file you need to debug the service.
    These files are copied to the enterprise server instance when you deploy. The .dat files hold the data accessed by the service. The .dll is the executable file you need to debug the service.

Stop Enterprise Server Instances

To ensure that your enterprise server instance does not encounter any port conflicts with other enterprise server instances that use the same listener port, stop all started enterprise server instances as follows:

  1. If the Server Explorer in Visual COBOL is not active, click Window > Show View > Other > Micro Focus > Server Explorer; then click OK.
  2. From the Server Explorer, expand Local [localhost:86] to see a list of enterprise server instances.
  3. Right-click each started enterprise server instance, and stop it by selecting Stop from the context menu. Started enterprise server instances show with a green icon Started enterprise server instance.

Start the ESSOAP Enterprise Server Instance

Before deploying your service interface, you must start the ESSOAP instance where the ProgramSOAP service will run.

  1. If the Server Explorer in Visual COBOL is not active, click Window > Show View > Other > Micro Focus > Server Explorer; then click OK.
  2. From the Server Explorer, expand Local [localhost:86] to see a list of available enterprise server instances.
  3. Right-click ESSOAP; then select Start from the context menu.
    Note: If this is the first time you have started the server you see a sign-on dialog box. If Store Credentials is checked, uncheck it; then click OK. Unchecking Store Credentials prevents this dialog box from showing when you subsequently start the region.

The Enterprise Server Daemon is then invoked via the Console, starting the enterprise server instance.

Deploy the ProgramSOAP Web Service

  1. In Eclipse, click the Console tab.
  2. On the icon bar, click the down arrow associated with Display Selected Console Display Selected Console.
  3. Click 3 Service Interfaces Console.
  4. From the COBOL Explorer, right-click the ProgramSOAP Web Service; then click Deploy.

The Console view shows the progression of the deployment process. If deployment was successful, you should see a message indicating success.

Note: If the console switches to the Micro Focus Build view after deployment, switch the view back to Service Interfaces Console to review the deployment log.

If deployment ever fails, you should find a message in the Console view indicating why it failed. Also, the failure message contains the path to the deployment log file. You can type the address into a browser and view the log file from there.

View deployment results

Now that your service interface has been deployed as a service running on the ESSOAP enterprise server, you can look at the details of the deployed service Enterprise Server Administration page.

  1. From Server Explorer, right-click Local [localhost:86]; then click Open Administration Page.

    The Enterprise Server Administration Home page appears in a window of the Eclipse IDE.

    In the row showing information for the ESSOAP enterprise server, you should see that the Objects column shows the number of services that this enterprise server runs. In this case, the number of running services should be at least 8. These are the four that come standard with the enterprise server, plus the one service you added containing four operations.

  2. Click the Details button for the ESSOAP Services.

    In the row showing your new service, ProgramSOAP, you'll notice that the Current Status column shows all four operations as Available. This means that the service is ready to be accessed by a client.

Previous Topic Next topic Print topic