Building OpenRemote 2.0 Web Console

The OpenRemote 2.0 Web Console is also available as a pre-compiled WAR which can be deployed into an existing Controller (Apache Tomcat) Runtime (or any J2EE compliant application server).

Download Pre-compiled Web Console WAR

OpenRemote 2.0 Web Console in Subversion

The latest developer release is available as a subversion checkout. The code branch is here:

/tags/project/WebConsole/WebConsole_1_0_0_Alpha1.

To checkout the release using subversion, use the following commands:

> svn co http://openremote.svn.sourceforge.net/svnroot/openremote/tags/project/\
  WebConsole/WebConsole_1_0_0_Alpha1

A    WebConsole_1_0_0_Alpha1/test
A    WebConsole_1_0_0_Alpha1/test/org

...

 U   WebConsole_1_0_0_Alpha1
Checked out revision 4456.

For IDE users, refer to your IDE documentation and it's subversion integration to achieve the same.

Pre-requisites & Dependencies

The web console is a Google Web Toolkit application that uses the Ext GWT framework to provide advanced UI Elements. The Web Console also uses GWT RPC calls that require server side (servlets) to fulfil that are also incorporated into the source code.

The following pre-requisites/dependencies need to be met:

JSONP Compatible Controller (latest version of controller)
Java 6 JDK
GWT 1.6.4 (needed for compiling, version 2.0+ not yet compatible)
Apache ANT (the version available from OpenRemote subversion is fine)
Apache Tomcat (or other J2EE application server, ideally use the same Tomcat server as the Controller)

Refer to the 'Building OpenRemote 2.0 Developer Releases' tutorial for details about checking out the Apache ANT and Tomcat tools from subversion.

Build Process

Before building the Web Console ensure you have met the pre-requisites and dependencies mentioned above and you will need to update the ANT 'build.properties' file in the root folder:

Set gwt.sdk to the absolute path of your GWT SDK (e.g. /media/libs_and_tools/gwt-linux-1.6.4)
Set deploy.dir to absolute path of Tomcat (application server deployment directory e.g. /media/openremote/Runtime/apache-tomcat-6.0.18/webapps)

> cd WebConsole_1_0_0_Alpha1
> nano build.properties

# Configure path to GWT SDK. IF you want compile the project, please download and config it.
gwt.sdk=/gwt/gwt-linux-1.6.4

The deploy.dir property is only needed if you want to automatically deploy the Web Console WAR after compiling.

To build, change directory to the Web Console source code root (where the build.xml file is located) and then call the Apache ANT tool with the appropriate build target as an argument, for example:

> cd WebConsole_X_0_0_AlphaX/
> ../Tools/apache-ant-1.8.2/bin/ant war
Buildfile: build.xml

clean:


 ...


war:
     [echo] --------------------------------------------------------------------
     [echo]  Packing war...
     [echo] --------------------------------------------------------------------
     [echo]
      [war] Building war: /media/openremote/WebConsole_1_0_0_Alpha1/
            WebConsole_1_0_0_Alpha1/output/webconsole.war

BUILD SUCCESSFUL
Total time: 75 seconds

It can take a long time to compile the Web Console because GWT generates a set of JavaScript files for each browser type.

Deploying the WAR

Deployment options:

Call Apache ANT with deploy argument instead of war (provided deploy.dir is configured correctly in the build.properties file) to automatically copy the webconsole.war to the deployment directory (if there is an existing deployed version it is automatically removed first).
The WAR file can be manually unzipped inside your application server's deployment directory in a sub folder called webconsole

Launching the Web Console

Once the application has been deployed to the application server it should be automatically loaded next time the server is started (or if the server was already running the WAR archive should have been extracted and launched automatically).

> cd ../Runtime/apache-tomcat-6.0.18/bin
> sh openremote.sh run

If running on the local computer with the default Apache Tomcat application server, the Web Console will now be available at:

http://localhost:8080/webconsole