Install the Eclipse IDE
The default development environment for KPME is Eclipse 3.5 or above. Any flavor should be ok, but it is recommended to start out with the Eclipse IDE for Java Developers since it is small.
Install Subversive
- Click Help -> Install New Software.
- In the Work with drop down menu, select the
http://download.eclipse.org/releases
entry that matches your Eclipse version. Go to Collaboration and select all required Subversive entries. - Click Finish and continue through all the screens in order to install your software.
- Restart Eclipse when promped.
Install M2Eclipse (Optional)
Note: Only complete this step if using Eclipse 3.6 or below. Eclipse 3.7 and above have switched to an internal Maven implementation, m2e.
- Help -> Install New Software.
- Click Add and add the location http://m2eclipse.sonatype.org/sites/m2e..
- Select your new repository from the drop down list.
- Find and select Maven Integration for Eclipse.
- Click Finish and continue through all the screens in order to install your software.
- Restart Eclipse when prompted.
Create the KPME Maven Project in Eclipse
You will be loading the project into your workspace from a repository via the Subversive plugin.
- In Eclipse, right click in the Package Explorer window and select New -> Other -> SVN -> Project from SVN.
- Select the option to Create a new repository location and select Next.
- Enter the URL https://svn.kuali.org/repos/kpme and other authentication information. Select Next to continue.
- Select "Browse" to bring up a dialog box where you can select the branch you will be working on. Most developers will be on trunk, so just select
trunk
if you are not given any additional instructions.

- Click Okay, then click Finish.
- When prompted how you want to check out your project, select Check out as a project with the name specified and make sure the name is
kpme
. Click Finish to begin the install process.
At this point, Subversive for Eclipse will begin the checkout process for KPME and create a new project in your workspace. When the checkout process is complete, do the following
- Right click your new
kpme
project and select Maven -> Enable Dependency Management. - Note: If you are not given a menu entry for "Maven", you must convert the project to a maven project. Right click on the project folder and select Configure -> Convert to Maven Project
Maven for Eclipse will download all the jars and files that are listed in the project POM's dependencies.
Install the Kuali Configuration File
In your new project, go to env/src/main/config
and copy the config files in the folder into your USER_HOME
.
- The main configuration file kpme-config.xml for your server environment should be
in USER_HOME/kuali/main/dev/kpme-config.xml
. - The test configuration file kpme-test-config.xml for your unit tests should be in
USER_HOME/kuali/test/dev/kpme-test-config.xml
.
Import existing maven projects
Now that we have our base project imported into our workspace, we also need to import each of the projects sub modules. This import will not create duplicate projects folders on disk, but rather derive themselves from the existing project.
- In the package explorer view, right click on the project created in the previous sections and select "Import".
- In the dialog box that pops up, expand "Maven" and select "Import Existing Maven Project".

- If the correct project was right-clicked, eclipse's maven should begin scanning the project tree for buried poms. If not, you may need to browse for the location manually ( example: kpme/core), or escape the dialog and try again.

- Once the analysis is complete, the "Import Maven Projects" dialog box should appear, populated with all poms under the project.

- Select all projects listed in the dialog box and click "Finish". This may take time, as the projects are imported and then converted to their maven form.

You'll notice the disdain in the workspace with all the newly imported projects. With eclipse, we can employ the use of working sets to organize our workspace.
Working Sets (this step is optional)
Optionally you can set up Working Sets in Eclipse using the steps described here:
Configure Working Sets
Starting the Application Server
- The scripts to launch the application version 2.* reside in the in the kpme-env module. This module also contains the local Kuali configuration files needed for start-up.
- In Eclipse, expand the kpme-env project, and go to
src/main/scripts
, right-click on the launch file KPME Jetty 7.launch and select Run As...and the file name. - If all goes well, the server will start up, populate your database, and then launch.
- Once you get the message that the server has started, open a browser and navigate to http://localhost:8080/kpme-dev/Time.do.
Troubleshooting
Error: Could not find or load main class org.codehaus.classworlds.Launcher
At a command prompt:
- You should receive output that displays version information about your maven installation. If you do not, verify that you have added the variable name M2_HOME, and added it to your path.
Javascript Validation causing build to hang
There are two methods for successfully turning off Javascript Validation in Eclipse:
1) Exclude from Path (best solution)
- Right click your project
- Select Properties -> JavaScript -> Include Path
- Select
Source
tab. ( It looks identical to Java Build Path Source tab ) - Expand JavaScript source folder
- Highlight
Excluded
pattern - Click
Edit
button - Click
Add
button next to Exclusion patterns
box and add the exclusion for the js folder.
The information about JavaScript source inclusion/exclusion is saved into .settings/.jsdtscope
file.
Here is how configuration looks with the js folder removed from validation

2) Turn off the JavaScript Validator in the "Builders" config for your project:
- Right click your project
- Select Properties -> Builders
- Uncheck the "JavaScript Validator"

Then restart your Eclipse.