ECG Gadget Technical Manual

From CVRG Wiki

Jump to: navigation, search

Contents

ECG Gadget System Requirements

If you are planning to host the Grid Node on a web server, it must be running Apache Tomcat 6.0. Earlier versions may work, but we are only supporting Tomcat 6.0.

If you are enhancing the Gadget, we recommend Eclipse Ganymede with the Google Web Tooklit plugins.

Here is a chart of software recommendations

Software Type Vendor/Name Minimum Recommended Version
Web Browser Mozilla Firefox 3.6.2
IDE Eclipse Ganymede
Development Language Java 6.0
Application Server Tomcat 6.0.18

Checking Out the Code

The checkout location for the ECG Gadget project is http://gforge.icm.jhu.edu/svn/ncbodbp

Please contact us to request access to our software version control system. Once you have obtained a user account in our version control system, copy/paste the above location into an SVN version control client, and you will be able to check out the code and modify it to suit your needs.

Remote Service Parameters

By default, the web service parameters are set to JHU's servers.

Setting Service Parameters

Navigate to the file NodeWidgetConstants.properties in the src/org/cvrgrid/widgets/node/client folder. Set the following parameters:

  • registrationServiceURL = http://[server]/axis2/services/nodeRegistrationService
  • remoteURL = http://[server]/cvrgftp
  • dataServiceURL = http://[server]/axis2/services/nodeDataService
  • analysisServiceURL = http://[server]/axis2/services/nodeAnalysisService
  • conversionServiceURL = http://[server]/axis2/services/nodeConversionService
  • ftpHost = [Remote ftp server where files are ultimately stored]
Example of constants file with parameters highlighted
Example of constants file with parameters highlighted

If you change them and are hosting the grid node client on a web server, add the NodeWidgetConstants.properties file to the TOMCAT_HOME/webapps/[node app directory]/WEB-INF/classes/org/cvrgrid/widgets/node/client folder.

Location of constants file in Tomcat
Location of constants file in Tomcat

Create and deploy web services

If you plan to host the broker services yourself instead of pointing them to the JHU broker services, follow these instructions.

  • In the bin folder of the cvrg-broker-service, go to each service's subdirectory. Send the meta-inf and the subfolder with the name of the service to a compressed (zip) file.
Create service's zip file
Create service's zip file
  • Change the extension of the zip file to .aar.
  • Copy the .aar file to the TOMCAT_HOME/webapps/axis2/WEB-INF/services directory.

Create and Deploy Grid Node War file

If you make your own enhancements to the grid node, it will be necessary to recompile the project and recreate your war file.

  • Once you are done with your enhancements, right click the cvrg-grid-node project in eclipse and go to the Google -> GWT Compile option.
Compile with GWT
Compile with GWT
  • There should be a subfolder named org.cvrgrid.widgets.node.NodeWidget inside the trunk\cvrg-grid-node\war directory. Copy the contents of this subfolder into the trunk\cvrg-grid-node\war\NodeWidget directory.
Copy contents of org.cvrgrid.widgets.node.NodeWidget subfolder
Copy contents of org.cvrgrid.widgets.node.NodeWidget subfolder
  • Copy the trunk\cvrg-grid-node\bin\org directory into the trunk\cvrg-grid-node\war\WEB-INF\classes directory.
Copy to classes directory
Copy to classes directory
  • If you added any jars to the project, add them to the trunk\cvrg-grid-node\war\WEB-INF\lib directory.
WEB-INF\lib directory
WEB-INF\lib directory
  • Add the trunk\cvrg-grid-node\war\WEB-INF and trunk\cvrg-grid-node\war\NodeWidget directories to a zip file and rename the file cvrgNode.war.
Create compressed file
Create compressed file
  • Copy the cvrgNode.war file to the TOMCAT_HOME\webapps directory on your web server. It should automatically deploy.
webapps directory with WAR file deployed
webapps directory with WAR file deployed

Link to ECG Gadget User Instructions

Click here for the ECG Gadget user manual.

Personal tools
Project Infrastructures