Previous Topic Next topic Print topic


Deploy a Service Interface

Restriction: This topic applies only when the Enterprise Server feature is enabled.

To successfully deploy a REST service interface to an enterprise server region, 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 where to find certain files.

  1. From the Solution Explorer, right-click the ProgramREST service interface; then click Properties.
  2. Ensure that the interface type property is set to REST Web Service (default).
  3. Click the Application files to deploy field, and then click the browse button to add the following files:
    File Location
    • appoint.dat
    • consultants.dat
    • customers.dat

    Your project's ProgramREST folder

    schedule.dll Your project's ProgramREST\bin\x86\Debug folder

    These files are copied to the enterprise server when you deploy. The .dll is the executable file you need to debug the service. The .dat files are data files accessed by the service.

Associate the ESDEMO Enterprise Server Region

You need to associate the ESDEMO enterprise server region with your ProgramREST project:

  1. From Server Explorer, expand localhost under Micro Focus Servers to see a list of available enterprise server regions.
  2. Right-click ESDEMO; then click Associate with Project > ProgramREST.

Start the ESDEMO Enterprise Server Region

Before deploying your service interface, you must start the ESDEMO region where the ProgramREST service will run.

  1. From the Server Explorer, expand localhost under Micro Focus Servers to see a list of available enterprise server regions.
  2. To start the ESDEMO enterprise server region, right-click it; then click Start.
    Note: If this is the first time you have started the server you see a sign-on dialog box. If Store Credentials is not selected, check it. Checking Store Credentials prevents this dialog box from showing by default when you subsequently start an enterprise server region. Then click OK.

The Enterprise Server Console Daemon is then invoked, starting the ESDEMO enterprise server region.

Build the ProgramREST Project

You need to generate a .dll executable file from your project to deploy with your service interface. This is necessary so that you can debug the service after generating a client.

  • From Solution Explorer, right-click the ProgramREST project; then select Build from the context menu.

Deploy to Enterprise Server

  • From the Solution Explorer, right-click the ProgramREST service interface; then click Deploy.

The Output window shows the progression of the deployment process. If deployment is successful, you should see a message indicating that deployment was completed. If the deployment process produced some warnings, this does not affect the validity of the deployment process.

If deployment were to fail, you should find a message in the Output window 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 ESDEMO enterprise server, you can look at the details of the deployed service via the Enterprise Server Administration page.

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

    The Enterprise Server Administration Home page starts in Visual COBOL.

    In the row showing information for the ESDEMO enterprise server, you should see that the Objects column shows the number of services that this enterprise server region runs. In this case, the number of running services should be at least 7. These are the five that come standard with the ESDEMO enterprise server, plus the one service you added containing two operations. You might see more if you have deployed other services to the ESDEMO enterprise server.

  2. Click the Details button for the ESDEMO Services.

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

  3. Close Enterprise Server Administration.
Previous Topic Next topic Print topic