Versions Compared

Key

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

...

OpenCDS Configuration in Eclipse

 

All OpenCDS sub-projects are contained within a parent project called “opencds-parent”.  An overview of these sub-projects will be made available in a separate document in the near future.

 

Import Projects into Eclipse

...

  1. Add the OpenCDS repository to the list of repositories available to Eclipse.

      ...

        1. Window  Show View  Other… SVN  SVN Repositories

       

      ...

        1. You will see a list of the configured Subversion repositories (your initial list may be empty).  Right-click on the list and choose

      ...

        1. New  Repository Location from the pop-up dialog

      ...

      ...

        1. 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

          ...

              1. Finis
              2. RepositoryURL and DescriptionAccess
                Main development trunk

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

          ...

              1. 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

          ...

              1. Stable snapshots from the main development trunk.

                Public read-only access.  ID and password not required.

          ...

          ...

          1. Import the OpenCDS Project Step 1: Establish Maven Projects

              ...

                1. Close Eclipse if open

              ...

                1. Check out OpenCDS parent project into the Eclipse OpenCDS workspace as follows:

                  ...

                      1. Go to workspace location (e.g., C:\OpenCDS)

                  ...

                      1. Right click and select SVN Checkout from context menu

                   

                   

                  ...

                      1. 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.

                   

                   

                  ...

                      1. 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)

                      ...

                            1. Run the command

                          ...

                                  1. mvn clean

                          ...

                                1. Run the command

                              ...

                                      1. mvn install

                              ...

                                    1. Run the command

                                  ...

                                          1. mvn eclipse:eclipse

                                  ...

                                          1. running this command creates all the Eclipse-specific project settings for OpenCDS so that you can work with it in Eclipse.

                                  ...

                                  ...

                                  1. Import the OpenCDS Project Step 2: Import Maven Projects

                                      ...

                                        1. Open Eclipse

                                      ...

                                        1. Import the OpenCDS parent project into Eclipse OpenCDS workspace as a Maven project, as follows:

                                      i)        File à Import à Maven à Existing Maven Projects à Next

                                       

                                       

                                       

                                      ...

                                          1. File  Import  Maven  Existing Maven Projects  Next
                                          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)

                                      ...

                                       


                                      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):

                                      ...

                                       

                                      ...

                                       


                                        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:\
                                                                                                          i.     
                                            1. Right click on opencds-parent
                                            à Run as à
                                            1.   Run as  Maven Clean
                                                                                                        ii.     
                                            1. Right click on opencds-parent
                                            à Run as à
                                            1.   Run as  Maven Install

                                        ...


                                        Troubleshooting

                                        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:

                                        ...

                                         

                                        Here are a couple suggestions to fix the problem:

                                        ...

                                        1. Check the results of the Maven Installs

                                          Maven will sometimes report a successful installation when the specified file (the “-Dfile=…” parameter) does not exist.  This will then cause downstream failures of Maven builds.  Verify that the local Maven repository contains the jar files you installed by looking in your local Maven repository (found as a folder named “.m2”  in your “User” directory).  For example, this path for the SpringSource jar will be:

                                          Pre
                                          .m2\repository\org\apache\jasper\springsource\com.springsource.org.apache.jasper.org.eclipse.jdt.springsource\6.0.20.S2-r5956\com.springsource.org.apache.jasper.org.eclipse.jdt.springsource-6.0.20.S2-r5956.jar

                                         


                                        1. If you find that one of the jars that you installed with a “mvn install …” command is missing, then rerun the installation, making sure that you have used the correct path for the source file, and spelled everything correctly.  The most common error is to download the files to the default download path on your machine (eg, “C:\yourUserName\Downloads”), but to install it using the sample command that we furnished which has a different path.  Another common problem is that the downloaded package might have a “.zip” extension, and needs to be changed to a “.jar” extension before use.

                                        ...


                                        1. The nuclear option

                                          If you cannot get things to work using the above approach (usually due to a Maven issue), you can reset your system to the state just prior to the Eclipse installation (section I.F) via the following:

                                          -

                                        ...

                                        1.     Delete Eclipse folder (e.g., C:\Program Files\eclipse)

                                          -

                                        ...

                                        1.     Delete OpenCDS workspace (e.g., C:\OpenCDS)

                                          -

                                        ...

                                        1.     Delete Maven repository (e.g., C:\Users\Ken\.m2)

                                        ...



                                        1. You can then re-attempt the installation and configuration process.

                                        ...



                                        Document Version History

                                        • 8/28/2011
                                          • Created by Kensaku Kawamoto based on configuration instructions for OpenCDS alpha release
                                          • Changes include:
                                            • Use of Drools and Guvnor 5.2 instead of 5.1.1
                                            • More information on 64-bit OS configuration
                                            • Use of newest releases of software components
                                        • 11/8/2011
                                          • Updated by Kensaku Kawamoto, with verification on 32-bit and 64-bit Windows OSs
                                          • Use of Drools 5.3.0 instead of 5.2.0
                                        • 11/9/2011
                                          • Updated by Kensaku Kawamoto to include use of SilkSVN for 32-bit OSs as well
                                        • 11/10/2011
                                          • Updated by Kensaku Kawamoto to note need to use latest Tortoise SVN version
                                        • 11/16/2011
                                          • Updated by Kensaku Kawamoto to include preliminary Guvnor/Designer installation instructions and to make additional note regarding Tortoise SVN
                                        • 11/29/2011
                                          • Updated by David Shields to include solution to failed installation of JBoss Application Server in a path including “Program Files (x86)”.
                                        • 12/16/2011
                                          • Updated by David Shields to include alternate installation paths, 2.0  version of JBoss Designer, alternate ports for JBoss, and availability of OpenCDS 1.0 binaries.
                                        • 12/17/2011
                                          • Updated by David Shields to include information on extended default timeout for JBoss AS 7.0.2
                                        • 11/14/2012
                                          • Major update by David Shields to reflect latest versions of all components, including Drools 5.4, JBPM Designer 5.3, and JBoss 7.1.x
                                        • 1/11/2013
                                          • Updated to reflect Drools 5.5, Designer 5.4
                                        • 5/24/2013
                                          • Updated to move Guvnor installation instructions to separate document

                                        ...