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.

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.
Attention: You might encounter an ESCWA Sign On dialog box as you perform the steps required to create, configure, start, or stop an enterprise server region from the Server Explorer. If you do, ensure that the Server requires credentials, Use specific server credentials, or Server is secured , and the Store credentials boxes are unchecked, and then click OK. If asked to provide a password, enter your UNIX logon password.

Start Enterprise Server Common Web Administration (ESCWA)

  • From the Eclipse Server Explorer, right-click the Local [localhost:10086] node, and then select Open Administration Page from the context menu.

    ESCWA starts in your default browser.

Create ESREST

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

  1. In ESCWA, click Native.
  2. In the navigation pane, expand Directory Servers, and then click Default.
  3. In the right pane, click New.
  4. In the Name field, type ESREST.
  5. Uncheck MSS Enabled.
  6. 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 Enterprise Developer installation folder, defining a deployment folder.

Enable Dynamic Debugging
  1. On Region and Server List page, hover over the ESREST entry, and then click the Edit Edit icon icon that appears to the right of the Security column.
  2. Under Startup Options, check Allow Dynamic Debugging.
  3. Click Apply.
Configure Listeners
  1. In the navigation pane, be sure that ESREST is selected.
  2. On the General drop-down list, select Listeners.
  3. In the Native Listener Navigation pane in the left-hand side, expand Communications Process 1, and click Web Services and J2EE.
  4. In the Port field, type 9003.
  5. Click Apply.
  6. Click the Web communication process n the navigation pane on the left.
  7. Change the value of the Requested Status field to Stopped.
  8. Click Apply.
Important: The default deployment directory used by Enterprise Server is a subdirectory, deploy, within your Enterprise Developer installation directory structure. If you have Administrator privileges to this subdirectory, 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 Enterprise Developer deployment folder. To ensure successful deployment, create a deploy subdirectory in your project.
  1. In the Application Explorer view, right-click the project, and then select New > Folder > 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.
  2. In the Folder name field, type deploy, and then click Finish.
Import the .mfdeploy file
The new deploy folder must contain the .mfdeploy configuration file. You import the file from the Application Explorer view.
  1. From the Application Explorer view, right-click the new deploy folder, and then select Import from the context menu.
  2. Expand General, and then click double-click File System.
  3. Click the Browse button that corresponds to the From directory field, and browse to the $COBDIR/deploy folder.
    Note: 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 .
  4. Click Open.
  5. Check .mfdeploy in the right pane.
  6. Click Finish to import the file into the project.
Define the deployment directory in ESCWA
Now you need to configure your enterprise server region by defining the new deploy project folder as the deployment folder.
  1. In ESCWA ensure that your enterprise server region is selected in the navigation pane, and the Communications Processes page is open in the right pane.
  2. Under Communications Process 1 in the lower left pane, select Web.
  3. In the Listener Properties pane, scroll down to the Custom Configuration field.
  4. Within the Custom Configuration 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=/home/hub/workspace/project-name/deploy

    where project-name is the name of the project.

  5. Click Apply.