OLE Development Environment Setup - Retire as covered in the latest dev guide.

Although the instructions should be portable to other platforms with some adjustments, this documentation assumes that you are using Windows. We recommend that you use the install paths in this documentation. If you choose not to, just make sure that you adjust accordingly when following related instructions. Also see Other Development Tools.

Install JDK 6

Install & Configure Eclipse

Download and Install Eclipse

Configure Eclipse

  • Change Eclipse Memory Settings
    • With Eclipse shut down, edit your eclipse.ini file (under your main Eclipse install directory on windows platforms)
      • Make a copy of the shipped file.  If this file is not in the format Eclipse expects, it will not start.
    • Add these lines to the file after the "-vmargs" line (if one or more of these exist, change the value to match the below):

      -Xms256m
      -Xmx768m
      -XX:PermSize=128M
      -XX:MaxPermSize=256M
      
  • Install Subclipse SVN Client
    • In Eclipse, go to Help->Install New Software...
    • Paste the URL below into the field and press Enter:
    • Click to select all of the categories displayed and click Finish.
    • Restart Eclipse when asked.
  • General Eclipse Settings
    • select "Preferences..." from the "Window" menu in eclipse
    • select General --> Compare/Patch: you may want to check "Ignore white space" here
    • select General --> Workspace": check "Refresh automatically"
    • select Java --> Installed JREs
      • if you don't already have a jre with a "Location" of (your JAVA_HOME system variable from above), click the "Add..." button, enter "jdk6" for the "Name", enter the location of your Java install for the "JRE Home Directory"
      • paste "-Xms256m -Xmx768m -XX:MaxPermSize=256m" into the "Default VM Arguments" textbox, and click "OK"
      • make sure the JRE you configured above is checked (and therefore the default)
    • click "OK" again to exit "Preferences"

Checkout Projects from SVN

  • SVN URLs to check out are:
  • Select Import from the File menu
  • Type "SVN" and select "Checkout Projects from SVN"
  • Select "Create a new repository location" and click "Next"
  • From the page above, enter the appropriate URL and click "Next"
  • Select the top element in the list and click next
  • If not selected, choose "Check out as a project in the workspace" The name should default in from the project.
  • Click Finish.

Configure Ant

  • select "Open Perspective" --> "Java (default)" from the "Window" menu
  • select "Show View" --> "Ant" from the "Window" menu
  • right click and select "Add buildfiles..."
  • select ole/build.xml and click "OK"
  • Repeat the above for the ole/ole-cfg-dbs/db-impex/impex/build.xml file. It will install with the name: kuali_db_impex

Build Local MySQL Database Instance (optional)

If you will not be using the OLELOCAL schema on oracle.ole.kuali.org, you will need to set up a local database environment on your workstation or another available computer. The instructions below assume you will be using a local MySQL database. (Highly recommended as it uses far less memory on your workstation than will a installation of Oracle XE.)

  1. Set up an instance of MySQL 5.1+ on your computer.
  2. Copy the ole/impex-build-local-mysql.properties file to your user home directory as impex-build.properties
    • Customize this file as needed. The defaults in the file should work except for the MySQL root account password.
  3. select "Show View" --> "Ant" from the "Window" menu
  4. Run the create-schema target from the kuali_db_impex ant file. This will build the database and user account. For subsequent refreshes, run the empty-schema target instead, which will drop the database and re-create it.
  5. Run the import target from the kuali_db_impex ant file. This will create and populate all the tables. This step will take 15-45 minutes.

Tomcat Server Setup

  • Open the Servers View (Window->Show View) (may be under Others...)
  • In the view, right click and select New->Server
  • Select the Apache / Tomcat v6.0 Server from the list.
  • Click the "Add..." link next to the Server Runtime Environment drop-down.
  • Under Tomcat Installation Directory, enter the path to your tomcat instance (ole\build\tomcat)
  • Select the JDK 1.6 runtime you set up earlier for the JRE.
  • Click "Finish"
  • Click "Finish" in the main server setup window.
  • Back in the Servers view, double-click the new server to open it.
  • Under General Information, click the "Open launch configuration" link.
    • Arguments Tab: In the VM Arguments, add these lines to the end:

      -Xmx768m
      -Xms256m
      -XX:MaxPermSize=256m
      -Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=false
      -Djava.awt.headless=true
      
    • Source Tab: Add the project source to the server (for debugging purposes)
      • Click the Add... button
      • Select "Java Project" and click "OK"
      • Select the ole project from the list.
      • Uncheck the two checkboxes at the bottom of the list.
      • Click OK.
    • Click OK.
  • Under Server Locations, select the radio button "Use tomcat installation"
  • Under Server Options, select "Serve modules without publishing"
  • Under Publishing, select "Never publish automatically"
  • Under Timeouts, change the timeouts each to 600. (The fields are sometimes not large enough, so click in the field and do a "select all" to ensure that you replace the existing value.
  • Save and close the server window.

Set Up Configuration Files

Before you can run the application, you need to set up some basic configuration files. Versions of these files have been provided and should only require minimal changes.

  1. Copy the ole/build/external/user/ole-build.properties file to your user home directory.
    • Customize this file for any differences between the defaults and your configuration. If you have used all the other defaults no modifications should be needed except for the base.directory property.
  2. Copy the ole/build/external/log4j.properties file to your user home directory.
    • This file should need no modifications except for changing the logging levels.

Run dist-local Ant Target

  1. select "Show View" --> "Ant" from the "Window" menu
  2. Run the dist-local target on the ole build file. See OLE Build Process Overview - Archive for details on this operation.
  3. Refresh the ole project. (Right-click on the project and select Refresh from the menu.)

Start up the Server

  • Open the Servers View (Window->Show View) (may be under Others...)
  • Select the server you configured earlier and start it.
  • Once the server completes loading, you should be able to access it at http://localhost:8080/ole-local/

Operated as a Community Resource by the Open Library Foundation