Set Up the ESREST Enterprise Server Instance

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.

Restriction: This topic applies to Windows environments only.

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 view is visible by default when using the Team Developer perspective, and appears as a tab on the same level as the Application Explorer view. However, if it is not visible:

In Eclipse, click Window > Show View > Other > Micro Focus > Server Explorer, and then click Open.

Start Enterprise Server Administration

From the Eclipse Server Explorer, right-click Local [localhost:86] and then click Open Administration Page.
The Enterprise Server Administration Home page starts in an Eclipse window.

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 Eclipse 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 COBOL Explorer, right-click the project, and then select New > Folder from the context menu.
In the Folder name field, type deploy, and then click Finish.
Note: To ensure that you can see the deploy folder in COBOL Explorer:
1. Click View Menu > Customize View .
  This opens the Available Customizations dialog box.
2. Uncheck Empty folders outside categories.
3. Click OK.

Import the .mfdeploy file

The new deploy folder must contain the .mfdeploy configuration file. You import the file from the COBOL Explorer.

From the COBOL Explorer, right-click the project folder; then select Import > Import from the context menu.
Expand General; then click double-click File System.
Click the Browse button that corresponds to the From directory field, and navigate to the %ProgramFiles(x86)%\Micro Focus\Visual COBOL\deploy folder.
Click Select Folder.
Check .mfdeploy in the right pane.
In the Into folder field, append \deploy to the existing value so that it points to the deploy subdirectory.
Click Finish to import the file into the project.

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=project-folder/deploy
```
where project-folder is the full path to your project folder, using forward slashes to separate subfolders. For example:
```
uploads=c:/Users/Bob/workspace/project-name/deploy
```
Click OK.
Click Home to return to the Home page.