File   		README 
Project		OAI Harvester Plug-In for Dspace
Author		Giridhar Manepalli

Dspace is a digital library system developed jointly by MIT Libraries and Hewlett-Packard
HP. The OAI harvester plug-in enables Dspace to harvest metadata and full text from 
OAI compliant data providers. Once harvested, the  records can be retrieved using Dspace
standard search interface. 

Installation
-------------------------------------------------------------------------

System Requirements
	Unix Compatible Operating System (Tested on Slackware Linux/GNU, Redhat Linux/GNU)
	Plugin per se works on any jvm supported OS
	Data Provider should be oai_dc compliant i.e metadata format should be dublin core

Details

Installing DSpace-Kepler involves installing the original Dspace from MIT and HP. 
For Installing the original Dspace, please log on to http://www.dspace.org

a) Install dspace from http://www.dspace.org

b) Download the jar version of harvester plug-in (plugin.jar) from 
http://kepler.cs.odu.edu/kepler/dspace/index.html
or
http://www.cs.odu.edu/~gmanepal/dspace

c) Also Download the XML SAX parser class files (xml.jar) 

d) Create a Directory for the installation of plugin (for further reference, I call it "plugin")

e) jar xvf plugin.jar in "plugin" directory

f) Files 
	plugin/
		build.xml
		conf/map.xml  Maps the DC Types of OAI Compatible to Dspace Compatible
		conf/dps.xml  Lists the DataProviders
		dspace/dc_dspace.java
		dspace/dc_parse.java
		dspace/cache.java
		tmp/*
		ns/*
		oairequester/*
		scheduler/*

g) jar xvf xml.jar in "xml" directory 
	Note: Here "xml" is used arbitrarily. 

h) Files
	xml/
		sax.jar
		xp.jar

i) Add sax.jar and xp.jar to classpath
	for eg, 
	In bash: CLASSPATH=$CLASSPATH:/home/gmanepal/xml/sax.jar:/home/gmanepal/xml/xp.jar; export CLASSPATH
	In csh:  set CLASSPATH = ($CLASSPATH /home/gmanepal/xml/sax.jar)
		 set CLASSPATH = ($CLASSPATH /home/gmanepal/xml/xp.jar)
				if CLASSPATH already exists
		 setenv CLASSPATH /home/gmanepal/xml/sax.jar:/home/gmanepal/xml/xp.jar
				if CLASSPATH doesnot exist

j) Note, if Java IDE like Netbeans, SUN ONE Application Server is used, use the following instead of setting
   the classpath
		Mount Filesystem for plugin 
		Mount Filesystem for sax.jar
		Mount Filesystem for xp.jar

		Skip step 'n'
 
k) Change Directory to plugin/

l) Edit file conf/dps.xml for entering Data Provider Details
	conf/dps.xml contains the Data Provider or the archivelet location to harvest

m) Edit file conf/map.xml for Mapping DC Attributes
	This file may be used to map DC atrributes from OAI to Dspace.
	This file is a simple example of crosswalk from OAI_DC/Dspace_DC

n) Run ant (already installed in original Dspace installation)
	Command: ant
	skip next step

o) "build all" from the plugin directory

p) If compiled from "ant" only
	If compiled from ant 
	copy plugin/conf/*.xml build/conf/*.xml
	make directory tmp in build 
	skip next step

q) Create a directory called build and create the following directory structure
	build/
	 	dspace/*.class ( All class files from plugin/dspace/*.java)
		conf/*.xml
		ns/*.class ( All class files from plugin/ns/*.java)
		oairequester/*.class ( All class files from plugin/oairequester/*.java)
		scheduler/*.class ( All class files from plugin/scheduler/*.java)
		tmp/ ( make directory called tmp) 

r) Change Directory to build/

s) Run Command: java scheduler/Harvest for Harvesting Metadata 

t) Run Command: java dspace/cache for Caching Full Text

u) Make sure that dspace bin directory(Usually it is /dspace/bin) is there in PATH Variable
	Note: This dspace is the dspace from MIT-HP

v) Run Command:dsrun org.dspace.app.itemimport.ItemImport -a -e <eperson number> -c <Collection Number> -s dc -m mapfile 
	<eperson> is the ID number that a registered user gets in Dspace
	<collection Number> is the ID number that a Collection gets in Dspace

w) Log on to http://your-dspace.edu/

x) Log into Admin Page , to manage the collection and recently added Records

y) The Startup page on http://your-dspace.edu/ is the page that can be used for browsing the records.

Contact
--------------------------------------------------------------------------
Feel free to contact 
		Giridhar Manepalli
		http://www.cs.odu.edu/~gmanepal/dspace
		gmanepal@cs.odu.edu
		dlib@list.odu.edu