Installing a REST Management Agent into a Java container
As part of the OpenEdge installation, REST Management Agent is installed in the OpenEdge installation directory, OpenEdge-install-dir\servlets\rest.
If you are using the Tomcat Web server installed along with the Progress Developer Studio for OpenEdge, you need not perform the following step. Instead, you can administer the Tomcat Web server using the protc utility as opposed to using the catalina.sh or catalina.bat scripts provided by Apache Tomcat. For more information on the protc utility, see Customizing Apache Tomcat Environment using the protc utility.
If you are not using the Tomcat Web server installed along with the Progress Developer Studio for OpenEdge, it is recommended that you use Apache Tomcat version 7.0.30 or later to deploy and run OpenEdge REST Web applications. Additionally, running OpenEdge REST Web applications requires Java 1.6 or later and Servlet API standard 3.0.
To start working with REST Web applications, you must configure your Web server to recognize the REST Management Agent. To configure your Web server, copy the REST Management Agent, oerm.war, from the directory, OpenEdge-install-dir\servlets\rest, to the Web server deployment directory.
For instance, if you are using a Tomcat Web server, you copy oerm.war to the $CATALINA_HOME/webapps directory.
Note: If you are using Tomcat Web server, you can also deploy oerm.war using the Tomcat manager. For more information, see the Tomcat manager documentation.
The following table shows how to perform the copy and paste operation using the command prompt in your operating system:
Table 70. Moving the installed sample Web application
Note: If the Web server is already running, you must restart the Web server for the new configuration settings to take effect.
You can query the REST Management Agent by browsing to the URL http://localhost:8980/oerm/index.html to check whether the REST Management Agent has been correctly installed and configured. For instance, if you are using the Tomcat server and you are using the default ports, you can browse the URL http://localhost:8980/oerm/index.html.
OpenEdge Management or OpenEdge Explorer allows you to install REST Management Agent instances. For more information, see the OpenEdge Management and OpenEdge Explorer: Configuration.
If you are using the Tomcat Web server installed along with the Progress Developer Studio for OpenEdge, you need not perform the following step. Instead, you can administer the Tomcat Web server using the protc utility as opposed to using the catalina.sh or catalina.bat scripts provided by Apache Tomcat. For more information on the protc utility, see Customizing Apache Tomcat Environment using the protc utility.