OLE Development Process - retire

Owned by Jonathan Keller
Last updated: Jan 22, 2014 by Peri Subrahmanya (Unlicensed)

This page describes the development process from a developer's standpoint when working on OLE from within an IDE.

Summary Process

  1. Check out the ole project from SVN. See: OLE Subversion Projects and Branches - Keep as per Peri (will update it)
  2. Per OLE Build Process Overview - Archive, copy the build/external/home/ole-build.properties to your user home directory.
    • Customize this file as needed for your own environment. See OLE Configuration Properties - Retire for more information on the properties which can be used in this file.

    • This is also where you would configure your database connections. This could point to a local satellite database or the central development Oracle database schema:

      JDBC URL:

      jdbc:oracle:thin:@oracle.ole.kuali.org:1521:XE

      Username:

      OLELOCAL

  3. Run the dist-local Ant target of the ole project.
    • This will build certain configuration files and copy them into external configuration directories as well as into the master source directory. (ole/work/src)
  4. Within Eclipse, refresh the project. (Select the project in the Project Explorer view and press F5 or right-click and select Refresh from the popup menu.)
    • This ensures that Eclipse notices the updated files from dist-local and copies them to the work/web-root/WEB-INF/classes directory where they need to be for running the local version of the application.
  5. Start up the server. This can be done within Eclipse if you followed the configuration instructions in OLE Development Environment Setup - Retire as covered in the latest dev guide., or by running the appropriate startup script in work/tomcat/tomcat/bin.

Important Directories Within the Project

work/src

The main source tree for the application.

work/web-root

The root for the web application context used when starting up the application on a developer's workstation.

build

Files related to the build process and additional libraries.

build/rice-lib

Library files extracted from the Rice project. This directory is populated automatically from the Rice WAR file and should not be modified directly.

build/ole-lib

Libraries added by the OLE project which are either not provided/needed by Rice or are more advanced versions of libraries provided by Rice.

build/tomcat

Unless configured otherwise, this is the Tomcat 5.5 server user for development.

test

Source, results, and additional libraries used by the unit test suites.

ole-cfg-dbs/development

The data project used for refreshing a local satellite database. Contains an XML and flat file representation of the OLE database structure and base data. Does not contain Rice server tables, those are in the directory below.

ole-cfg-dbs/rice

The data project for a rice database. This directory is extracted directly from the Rice SVN repository. It contains the structure and data for a standalone Rice instance.

ole-cfg-dbs/db-impex/impex

The database import/export tool used for refreshing a local satellite database.

work/db/rice-data

Liquibase and CSV files which are used to overlay the Rice data needed by OLE on top of a baseline Rice database schema.

work/web-root/WEB-INF/classes

The target directory for compilation. The Java IDE should also copy any non-Java files (e.g., XML files) from work/src to this directory.

work/web-root/WEB-INF/lib

This is the library directory used by the web application. It is constructed automatically by the dist-local target from the contents of the build/rice-lib and build/ole-lib directories.

Operated as a Community Resource by the Open Library Foundation