NIH | National Cancer Institute | NCI Wiki  

Question: How do I configure Eclipse for caArray?

Topic: caArray Installation and Upgrade

Release: Up to caArray 2.X

Date entered: 05/18/2009
Date modified: 09/25/2010

Answer

Please follow these instructions to get caArray trunk codebase configured inside Eclipse:

1. Use a SVN client such as Sliksvn or Subclipse plugin for Eclipse to check out the caArray codebase. You have to choose the trunk or a branch to a new and clean directory (<trunk home>: for example: c:\apps\caarray2).
2. Install IvyDE Eclipse plugin for Ivy classpath management and restart Eclipse.
3. Go to "Window" / "Preferences" / "Ivy" and set "Global settings" by navigating to <trunk home>/software/master_build/ivy-caarray-settings.xml and click "OK".
4. Open the <trunk home>/software/master_build/ivy-caarray-settings.xml file in a text editor and comment-out the filesystem resolver with name 'local-repo', as this resolver is only useful for developers at NCI, then save the file. The portion of XML code to be commented out is shown below:

Ivy DEXML Settings

The modified XML file is attached below for reference:ivy-caarray-settings-modified.xml

5. In Eclipse Navigator tab, right click in panel and select "Import", and then "Existing Projects into Workspace" and in "Select root directory" navigate to <trunk home> and click "Finish".
6. Make sure that you have Ant 1.7+ in your PATH.
7. Make sure that JAVA_HOME environment variable set to Java 1.5.x.
8. Make sure that your computer has network access to the MySQL database containing caArray schema (You should have the database up and running).
9. Make sure that the bin directory of your svn client such as sliksvn is in your PATH.
10. Make sure to have variable "ANT_OPTS" defined and "-Xmx1024m" as variable value. Your computer needs to have at least 1.5 GB of memory.
11. It was previously possible to deploy caArray to a non-caArray installer-provided JBoss server, but with 2.4.0 it is no longer the case. Developers should first install caArray using either the command line or GUI installer, and then should configure a deployment properties file to deploy caArray codebase to the installer-provided JBoss server. Actually, it is a good practice to do it for any version.
12. Make sure that the JBOSS_HOME points to the root directory of your JBoss 4.0.5.
13. Create a new file <trunk home>/software/build/local.properties (A sample of a customized local.properties file is attached to this article for reference.) Save it as local.properties). Property values depend on your environment. Some of the properties that you most likely will need are:

(1). database.system.user=<root>
(2). database.system.password=<root user's password>
(3). database.server=<MySQL server>
(4). database.port=<MySQL port>
(5). database.user=<caArray DB connection username>
(6). database.password=<caArray DB connection password>
(7). database.name=<caArray DB name>

14. Start a window command prompt, go to the <trunk home>/software/build directory, type "ant" to build caArray and to run all unit tests and code checks.
15. The build might fail with a single error during Unit testing, which is ok at this point. Please verify this by clicking <trunk home>/software/build/site/junit/unit/index.html.
16. Type "ant deploy" in <trunk home>/software/build to deploy caArray.
17. Go to the JBoss bin directory and start JBoss using the run.bat/sh script. The caArray.ear should be deployed.
18. Go to "http://yourcomputername:8080/caarray/" to see the web interface of the running caArray application installed on your computer.
19. If you are having problems with svn:getinfo target failing during builds, just pass in the following ant command-line property: -Dnosvn=true.
20. With this process, you should have the caArray project in Eclipse and be able to build and run caArray at the command line. We are testing to see if there are caveats with building from Eclipse.

Have a comment?

Please leave your comment in the caArray End User Forum.