Walks you through the process of creating and configuring an
enterprise server instance, ESREST, to use in this tutorial.
Restriction: This topic applies only when the Enterprise Server feature is enabled.
To successfully deploy, and run or debug, a REST Web service, you must have an
enterprise server instance configured and started in
Enterprise Server. For this tutorial, you create the ESREST
enterprise server instance, set its listener port, and optionally configure a deployment folder for it to use.
Start the Server Explorer
The
Server Explorer expandable ribbon is visible in Visual Studio on the top left side of the IDE by default when using
Visual COBOL. However, if it is not visible:
- In Visual Studio, click
View > Server Explorer.
Start
Enterprise Server Administration
Create ESREST
In this section, you create the ESREST
enterprise server instance from the
Home page in
Enterprise Server Administration.
- From the
Enterprise Server Administration
Home page, click
Add.
- In the
Server Name field, type
ESREST.
- Click
Next.
- Under
Server Type, select
Micro Focus
Enterprise Server; then click
Next.
- On the
Add server (Page 3 of 3) page, click
Add.
Configure ESREST
By default, your new
enterprise server instance is already configured for REST Web services; however, you must make some adjustments, which include enabling dynamic debugging,
setting an endpoint address for the Web Services and J2EE listener, and if you do not have Administrator privileges to the
Visual COBOL installation folder, defining a deployment folder.
- Enable Dynamic Debugging
-
- On the
Enterprise Server Administration
Home page in the table of servers, click the
Edit button that corresponds to the
ESREST server.
- On the
Server > Properties > General page (default), in the
Startup Options group, check
Allow Dynamic Debugging, and then click
OK.
This returns you to the
Home page.
- Configure Listeners
-
- On the
Enterprise Server Administration
Home page, in the
Communications Processes column for the
ESREST server, click the
Details button.
This takes you to the
Communications Processes page for
Enterprise Server listeners.
- Click the
Edit button that corresponds to
Web Services and J2EE.
- Change the contents of the
Endpoint Address field to
*:9003.
- Click
OK.
This returns you to the
Communications Processes page.
- Click the
Edit button that corresponds to
Web listener.
- Change the value of the
New Status field to
Stopped. This enables deployment of a REST service interface.
- Click
OK.
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
Visual Studio 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.
- In the
Solution Explorer, right-click the project, and then select
Add > New Folder from the context menu.
- 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.
- From the
Solution Explorer, right-click the
deploy folder; then select
Add > Existing Item.
- Browse to the
%ProgramFiles(x86)%\Micro Focus\Visual COBOL\deploy folder.
- Set the filter drop-down list to
All Files (*.*).
- Double-click the
.mfdeploy file.
- Define the deployment directory
- Now you need to configure your
enterprise server instance by defining the new
deploy project folder as the deployment folder.
- 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.
- In the row for the
Web listener name, click
Edit.
- 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=c:/tutorials/IMTK/project-name/deploy
where
project-name is the name of the project.
- Click
OK.
- Click
Home to return to the
Home page.