Versions Compared

Old Version 6

changes.mady.by.user Alisha Edison-Hair (Unlicensed)

Saved on

compared with

New Version 7

changes.mady.by.user Alisha Edison-Hair (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Download Eclipse from http://www.eclipse.org/downloads/
    1. Compatibility note:  as of 11/8/2011, the JBoss Drools Eclipse Workbench is not available as a stable release for Eclipse version 3.7.X (Eclipse Indigo).  Therefore, it is recommended that Eclipse Helios (version 3.6.X) or newer Eclipse is used instead.
      1. Update as of 11/14/2012: the above issue is no longer a problem
    2. In this example, installed Eclipse Helios version 3.6.2 from http://www.eclipse.org/downloads/packages/release/helios/sr2
    3. Select 32 or 64-bit version, whichever is appropriate for your machine/OS.
  2. Create an Eclipse instance by unzipping the zip archive into a directory of choice
    1. NOTE: if you already have eclipse installed (e.g., at C:\Program Files\eclipse) for other projects you are working on, we strongly recommend that you install eclipse in a different directory (e.g., C:\Program Files\eclipseOpenCDS).  This way, you will not impact any existing code or Eclipse settings (e.g., with regard to plugins).  Furthermore, in the event that you need to uninstall and reinstall OpenCDS, you will be able to delete the OpenCDS eclipse folder without impacting any other projects.

    2. The default directory used for these instructions is C:\Program Files\eclipse, which is where the Eclipse instance will be created if you unzip the zip archive directly into C:\Program Files

  3. Notes
    1. You do not need to modify your path or add environment variables to use eclipse
    2. Read the release notes (especially if you have problems) found at C:\Program Files\eclipse\readme\readme_eclipse.html
    3. Remember that you can often fix weird problems in eclipse from a command prompt by running “eclipse –clean” which will start eclipse with a clean slate (and make it forget all the in-process state of files you were currently working on)
  4. Create a shortcut for Eclipse that passes in Java Virtual Machine parameters that a) ensures that the JDK is used rather than the JRE and b) ensures sufficient memory is allocated.  Then, use the shortcut for launching Eclipse.  Different shortcuts can be created if different Eclipse configurations are desired.

    1. E.g., edit target of shortcut to:

      Pre
      "C:\Program Files\eclipse\eclipse.exe" -vm "C:\Program Files\Java\jdk1.6.0_26\bin" -vmargs -Xmx900m




    2. Alternatively, the

      Pre
      C:\Program Files\eclipse\eclipse.ini

      can be edited.

      1. For more information, see

        http://wiki.eclipse.org/FAQ_How_do_I_increase_the_heap_size_available_to_Eclipse%3F,

        http://wiki.eclipse.org/Eclipse.ini.

  5. When first starting Eclipse, set workspace to appropriate directory

    1. Suggested location is “C:\OpenCDS”

    2. An alternate suggested location if installing multiple versions of OpenCDS on the same machine is “C:\OpenCDS_[version]”

      1. e.g., “C:\OpenCDS_v1.0_preview”, “C:\OpenCDS_alpha”, “C:\OpenCDS_v1.1.2”, etc.

...

    1. Install M2Eclipse
      1. Before you can use Maven from Eclipse, you will need to make sure that you are running Eclipse from the JRE that is part of a JDK virtual machine.  One safe way to do this is to create a shortcut for running Eclipse, and adding the path to the JDK in the shortcut target, as described above under the Eclipse installation instructions.
      2. From Eclipse Marketplace – DO NOT DO THIS!  You will need to do the initial install the traditional way, as described next (the Eclipse Marketplace does not currently allow you to do a base install of m2eclipse)…
      3. From Install New Software
        1. Help → Install New Software
          Image Added

        Type just the URL (http://m2eclipse.sonatype.org/sites/m2e) (1), click the Add button (2), type in “m2eclipse” for the name, and hit “okay” for adding the repository.  You should then click in the box beside “Maven Integration for Eclipse (3), and click the Next button at the bottom of the Install window.

        It will verify your selection (making sure dependencies are present), and then give you a chance to go back to add dependencies, or continue by clicking Next

        Accept the license and click Finish.

        Restart Eclipse if prompted.

        If you get the following warning, click OK to ignore
        Image Added

        If you get the following error, restart the machine and try again.
        Image Added


    2. Make sure Eclipse is pointed to a JDK rather than a JRE in Eclipse Preferences (Windows → Preferences → Java → Installed JREs and Windows → Preferences → Java → Installed JREs → Execution Environments)
      slaklsaImage Added
      slalfdksj
      kslaImage Added

    3. Install Subclipse
      1. From Eclipse Marketplace:  DO NOT DO THIS!  It installs correctly, but is missing some important functionality.
        1. UPDATE:  The install from Eclipse Marketplace has apparently been fixed.
      2. From Install New Software
        1. Select all options from the menu after you enter / select the path as shown below
          1. URL = http://subclipse.tigris.org/update_1.8.x
          2. Name = anything; suggest “Subclipse”
        2. Image Added

        3. Click on Next
          1. It will verify your selection (making sure dependencies are present), and then give you a chance to go back to add dependencies, or continue by clicking Next.
        4. Accept the license and click Finish
        5. If you get the following warning, click OK to ignore.
          Image Added

        6. Restart Eclipse if prompted
    4. Set Eclipse Preferences for Subversion
      1. Window → Preferences → Team → SVN
      2. Select a client for the SVN Interface
        1. If no clients are listed, you probably installed Subclipse from the Marketplace, and didn’t get the client.  Go back to the step about installing Subclipse and get the client.
        2. For this example, JavaHL is selected
      3. Window → Preferences → Team → SVN → Menu icons
        1. Select Tortoise SVN
    5. Set up Tomcat Server in Eclipse
      1. File → New → Other → Server → Server
        1. Select Apache Tomcat (e.g., Tomcat 7.0) and use default settings
        2. Image Added
      2. Select installation directory, Finish
    6. Set Eclipse Preferences for Maven

      1. Window → Preferences → Maven → Installations → Add → specify Maven root folder (e.g., C:\Program Files\Apache Software Foundation\apache-maven-3.0.3) → OK

         

         Image Added

      2. Create a settings.xml file in location specified in Eclipse under Window → Preferences → Maven → User Settings
        Image Added

      3. Sample XML (used for this example):

        Pre

        <?xml version="1.0" encoding="UTF-8"?>

        <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0http://maven.apache.org/xsd/settings-1.0.0.xsd">

        <pluginGroups>

               </pluginGroups>

               <proxies>

               </proxies>

               <servers>

               </servers>

               <mirrors>

               </mirrors>

               <profiles>

               </profiles>

        </settings>

      4. Restart Eclipse
      5. Update central Maven repository index, as follows.  Note that if you don't do it here, it will automatically take place later in the installation process.  We recommend updating the index here, so that if there is an error, it is clear where the error occurred.
        1. Windows → Show View →Other → Maven → Maven Repositories
          1. Click Global Repositories → right click "central", select Update Index
          2. This may take a while; you can track progress by clicking on the progress icon on the bottom right of the screen  ()
          3. Sometimes, it takes multiple attempts before this completes.  You may need to restart Eclipse in the process.
          4. If you see an error message of "Unable to update index for central," it may mean you need to turn off a Proxy connection (see http://www.ehow.com/how_6079770_using-proxy-server.html) or configure Proxy-based Maven connections (see http://maven.apache.org/guides/mini/guide-proxies.html).  Once you have made the changes, verify that you do not get this error by repeating the steps above.
    7. InstallJbossDrools Eclipse Workbench (allows writing Drools rules and working with Drools Flow, and testing / debugging directly from Eclipse; part of JBoss Tools).
      1. Automatic installation from Eclipse
        1. Download Drools plugin for Eclipse
          1. Help → Install New Software
          2. Use appropriate URL found at http://www.jboss.org/tools/download.html.  In this case, use http://download.jboss.org/jbosstools/updates/stable/helios/
          3. Name used in this example for repository: Drools
          4. Install the three Drools components indicated below under the SOA Development category
            Image Added

          5. If you get the following warning, click OK to ignore.
            Image Added

          6. Restart Eclipse if prompted
      2. Download the Drools Runtime version 5.5.0.Final
        1. Download file named Drools Binaries from http://www.jboss.org/drools/downloads.html, using link at
          http://download.jboss.org/drools/release/5.5.0.Final/drools-distribution-5.5.0.Final.zip
        2. Place contents of the binaries folder in the zip archive into a directory (C:\Data\Drools\Drools5.5.0.Final is used in this guide)
        3. E.g., this directory should look like the following:
          Image Added

      3. Configure Drools Eclipse Workbench
        1. Windows → Preferences → Drools → Installed Drools Runtime → Add
          1. Add the version of Drools (since you are allowed to have more than one installed) that you want to add to the build path of newly created Drools projects (the example below shows an older version, you should use the current version of Drools that you have just installed).
            Image Added
        2. Select the Drools runtime for use (Use the current version, not 5.3 as shown below)
          Image Added

        3. Restart Eclipse

 

OpenCDS Configuration in Eclipse

...

  1. Add the OpenCDS repository to the list of repositories available to Eclipse.
    1. Window → Show View → Other…→ SVN → SVN Repositories
      Image Added

    2. You will see a list of the configured Subversion repositories (your initial list may be empty).  Right-click on the list and choose New → Repository Location from the pop-up dialog
      Image Added

    3. Add the repository for the OpenCDS Trunk Project.  The relevant URLs are as follows.  Most individuals should initially connect to the 1.x release repository.

      1. E.g., enter http://develop.opencds.org/svn_v1.0/trunk/opencds-parent, and click on Finis

        RepositoryURL and DescriptionAccess
        Main development trunk

        http://develop.opencds.org/svn_active/trunk/opencds-parent

        Locus of the active development on 1.x releases.

        		Currently restricted to active code contributors.  Access may be requested from David Shields at david.shields@opencds.org.
        1.x release

        http://develop.opencds.org/svn_v1.0/trunk/opencds-parent

        Stable snapshots from the main development trunk.

        		Public read-only access.  ID and password not required.
  2. Import the OpenCDS Project Step 1: Establish Maven Projects
    1. Close Eclipse if open
    2. Check out OpenCDS parent project into the Eclipse OpenCDS workspace as follows:
      1. Go to workspace location (e.g., C:\OpenCDS)
      2. Right click and select SVN Checkout from context menu
        Image Added

      3. Enter URL of repository and proceed, as noted below.  Note that the URL of the repository should be the appropriate one noted in the table above.  Also note that you must add “opencds-parent” to the end of the Checkout directory.
        Image Added

      4. Now, build the project with Maven from the command line
        1. From the command line, go to the opencds-parent folder in the workpace (e.g., C:\OpenCDS\opencds-parent)
        2. Run the command
          1. mvn clean
        3. Run the command
          1. mvn install
        4. Run the command
          1. mvn eclipse:eclipse
          2. running this command creates all the Eclipse-specific project settings for OpenCDS so that you can work with it in Eclipse.
  3. Import the OpenCDS Project Step 2: Import Maven Projects
    1. Open Eclipse
    2. Import the OpenCDS parent project into Eclipse OpenCDS workspace as a Maven project, as follows:
      1. File → Import → Maven → Existing Maven Projects → Next
        Image Added

      2. Root Directory → Browser → opencds-parent location (e.g., C:\OpenCDS\opencds-parent).  Select all Projects, Finish (the latest version of OpenCDS may have slightly different modules than those shown in the example below)
        Image Added


Build OpenCDS Eclipse Project

  1. Following the process above, you should see something similar to the following in Eclipse as built projects (there are more modules as time goes on, and some get renamed as well):
    Image Added
    1. A build has already taken place from the command line as a part of the setup process.  For future builds, you can do through the following procedure:\
      1. Right click on opencds-parent → Run as → Maven Clean
      2. Right click on opencds-parent → Run as → Maven Install

...

Maven is great when things are working.  However, it can be challenging to get things to work when Maven is not working.  The most common problem will look something like this: 

Image Added

Here are a couple suggestions to fix the problem:

...