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 REST 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 where to find certain files.
- From the
COBOL Explorer, expand
ProgramREST > Web Services
- Right-click the
ProgramREST Web service; then select
Properties from the context menu.
- On the
Deployment Server tab, click the
Change button that corresponds to the
Enterprise Server name field.
- In the
Server column, click
ESREST; then click
OK.
- 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
ProgramREST 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 when you deploy.
- Click
OK.
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:
- If the Server Explorer in
Visual COBOL is not active, click
Window > Show View > Other > Micro Focus > Server Explorer; then click
OK.
- From the Server Explorer, expand
Local [localhost:86]
to see a list of
enterprise server instances.
- 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
.
Start the ESREST Enterprise Server Instance
Before deploying your service interface, you must start the ESREST instance where the ProgramREST service will run.
- If the Server Explorer in
Visual COBOL is not active, click
Window > Show View > Other > Micro Focus > Server Explorer; then click
OK.
- From the Server Explorer, expand
Local [localhost:86]
to see a list of available
enterprise server instances.
- To start the
ESREST
enterprise server instance, 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 instance. Then click
OK.
The Enterprise Server
Daemon is then invoked via the Console, starting the ESREST
enterprise server instance.
Deploy the ProgramREST
Web Service
- In Eclipse, click the
Console tab.
- On the icon bar, click the down arrow associated with
Display Selected Console
.
- Click
3 Service Interfaces Console.
- From the
COBOL Explorer, right-click the
ProgramREST 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 ESREST enterprise server, you can look at the details of the deployed service via the Enterprise Server Administration page.
- If you have closed the Enterprise Server Administration window in
Visual COBOL, start it again.
In the row showing information for the ESREST enterprise server, you should see that the
Objects column shows the number of services that this enterprise server instance runs. In this case, the number of running services should be at least
4. These are the two that come standard with the enterprise server, plus the one service you added containing two operations. You might see more if you have deployed other services to the ESREST enterprise server.
- Click the
Details button for the ESREST 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.
- Close Enterprise Server Administration.