Create and Configure ESREST

Walks you through the process of creating and configuring an enterprise server instance, ESREST, to use in this tutorial.
Restriction: This topic applies to Windows environments (local development) only.

To successfully deploy and run (debug) a Web Services service interface, you must have an enterprise server instance started in Enterprise Server. For these tutorials, you create the ESREST enterprise server instance, set its listener port, and configure a deployment directory for it to use.

Start Enterprise Server Administration

  1. From Server Explorer in Enterprise Developer, right-click Local [localhost:86]; then click Open Administration Page.

    The Enterprise Server Administration Home page starts in an Enterprise Developer window.

Create ESREST

In this section, you create the ESREST enterprise server instance from the Home page in Enterprise Server Administration.

  1. From the Enterprise Server Administration Home page, click Add.
  2. In the Server Name field, type ESREST; then click Next.
  3. Under Server Type, select Micro Focus Enterprise Server; then click Next.
  4. On the Add server (Page 3 of 3) page, click Add.

Configure ESREST

By default, your new enterprise server instance is already configured for the REST architectural style; 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 directory, defining a deployment directory.

Enable Dynamic Debugging
  1. On the Enterprise Server Administration Home page in the table of servers, click the Edit button that corresponds to the ESREST server.
  2. On the Server > Properties > General page (default) in the Startup Options group, check Allow Dynamic Debugging; then click OK.

    This returns you to the Home page.

Configure the Web Services and J2EE Listener
  1. 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.

  2. Click the Edit button that corresponds to Web Services and J2EE Listener.
  3. Change the contents of the Endpoint Address field to *:9003.
  4. Click Apply.

    This returns you to the Communications Processes page.

    Important: If you do not have Administrator privileges to the Enterprise Developer installation directory, continue with the configuration. Otherwise, configuration for the ESREST enterprise server instance is complete at this point. Click Home to return to the Home page.
Define a Deployment Directory
The default deployment directory used by Enterprise Server is a subfolder to your Enterprise Developer installation directory. If you have Administrator privileges to the Enterprise Developer installation directory structure, or if you started Enterprise Developer using Run as Administrator, you are not required to complete this section of the tutorial.
  1. Back on the Communications Processes page, click the Edit button that corresponds to the Web listener.
  2. 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=ProjectDir/deploy
    where ProjectDir is the full path to your project directory, using forward slashes to separate subdirectories. For example:
    uploads=c:/Users/Bob/workspace/project-name/deploy
  3. Click OK.
  4. Click Home to return to the Enterprise Server Administration Home page.

Create a Deployment Directory

The default deployment directory used by Enterprise Server is a subfolder to your Enterprise Developer installation directory. If you have Administrator privileges to the Enterprise Developer installation directory structure, or if you started Enterprise Developer using Run as Administrator, you are not required to complete this section of the tutorial.

Create the deploy folder
Without Administrator privileges, you cannot deploy to Enterprise Server from the default Enterprise Developer deployment directory. To ensure successful deployment, create a deploy folder in your ProgramREST project.
  1. In the Team Developer Tree View, right-click the project; then select New > Folder > Folder from the context menu.
  2. In the Folder name field, type deploy; click Finish.
Import the .mfdeploy File
The new deploy folder must contain the .mfdeploy configuration file. You import the file from the Team Developer Tree View.
  1. From the Team Developer Tree View, right-click the deploy folder; then select Import from the context menu.
  2. Expand General; then click double-click FileSystem.
  3. Click the Browse button that corresponds to the From directory field, and navigate to
    InstallDir\deploy

    where InstallDir is your Enterprise Developer installation directory. By default, this is %ProgramFiles(x86)%\Micro Focus\Enterprise Developer.

  4. Click OK.
  5. Check .mfdeploy in the right pane.
  6. Click Finish to import the file into the project.