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 COBOL perspective, and appears as a tab on the same level as the COBOL 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 Common Web Administration (ESCWA)

From the Eclipse Server Explorer, expand Local [localhost:10086].
Right-click Default [127.0.0.1:86] and then click Open Administration Page.
The Region and Server List page in ESCWA is displayed in your default browser.

Create ESREST

In this section, you create the ESREST enterprise server instance from the ESCWA Administration page.

In ESCWA, click NATIVE.
In the navigation pane, expand Directory Servers, and then click Default.
In the right pane, click New.
In the Name field, type ESREST.
Uncheck MSS Enabled.
Click Save.

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 REGION AND SERVER LIST page, hover over the ESREST entry, and then click the Edit icon that appears to the right of the Security column.
Under STARTUP OPTIONS, check Allow Dynamic Debugging.
Click APPLY.

Configure Listeners

In the navigation pane, be sure that ESREST is selected.
On the GENERAL drop-down list, select Listeners.
Expand Communications Process 1, and click Web Services and J2EE.
In the Port field, type 9003.
Click APPLY.
Click the Web communication process.
Change the value of the Requested Status field to Stopped.
Click APPLY.

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.
Note: If Folder is not an option on the context menu, click Other, and create a new deploy folder from there.
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 > Filters and Customization .
  This opens the Filters and Customization dialog box.
2. Uncheck .* resources and 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 new deploy 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 browse to the %ProgramFiles(x86)%\Micro Focus\Visual COBOL \deploy (Windows) or /opt/microfocus/VisualCOBOL/deploy (UNIX) folder.
Note: On UNIX platforms: If the .mfdeploy file is not listed on the Import from directory dialog box, right-click in the dialog box, and check Show Hidden Files to view .mfdeploy on the list .
Click Open.
Check .mfdeploy in the right pane.
Click Finish to import the file into the project.

Define the deployment directory in ESCWA

Now you need to configure your enterprise server instance by defining the new deploy project folder as the deployment folder.

In ESCWA click NATIVE.
In the ESCWA navigation pane, expand Directory Servers > Default, and then select your enterprise server instance.
On the GENERAL drop-down list, select Listeners.
Expand Communications Process 1, and click Web.
In the LISTENER PROPERTIES pane, scroll down to the Custom Configuration 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:
```
Windows: uploads=c:/Users/Bob/workspace/project-name/deploy
```
```
UNIX: uploads=/home/hub/workspace/project-name/deploy
```
where project-name is the name of the project.
Click APPLY.