Installing the EUL Add-On (v0.1)

The following instructions will guide you through installing the EUL Add-On to DSpace. The process is fairly simple, although in some steps it is necessary to modify DSpace files in order to make the system work.

In order to make a clear distinction between your DSpace install and our Add-On source code, we will use the notation:

[eul] - The directory in which you have the unpacked EUL Add-On code.

[dspace] - Your target DSpace installation to add our code to.

  1. Download and unpack the .tar.gz file available here.
  2. Ensuring that ant is in the environment path, go to the [eul] directory and use the following command:

    ant -Ddslib=[dspace]/lib

    Followed by:

    ant install

    This will create an eul-dspace.jar file in the build directory
  3. Copy the eul-dspace.jar from the [eul]/build/ directory into the [dspace]/lib/ directory.
  4. Open a console to your dspace database (e.g. psql dspace), and use the following SQL to create the required databases: 

    CREATE SEQUENCE eulepersongroup2workspaceitem_seq;

CREATE TABLE EULepersongroup2workspaceitem (
	id integer DEFAULT nextval('EULepersongroup2workspaceitem_seq'),
	eperson_group_id integer,
	workspace_item_id integer,
	CONSTRAINT EULepersongroup2item_pkey PRIMARY KEY (id)
);

CREATE SEQUENCE eulworkspaceitemnotes_seq;

CREATE TABLE eulworkspaceitemnotes (
	note_id integer DEFAULT nextval('eulworkspaceitemnotes_seq'),
	item_id integer,
	note text,
	submitter_id integer,
	date_submitted timestamp without time zone,
	CONSTRAINT eulworkspaceitemnotes_pkey PRIMARY KEY (note_id)
);

  5. Go to [dspace]/jsp/WEB-INF/ and open up the file web.xml for editing. Under the relevant sections, enter the following code: 

    <!-- Servlets -->

<servlet>
    <servlet-name>supervise</servlet-name>
    <servlet-class>ac.ed.dspace.SuperviseServlet</servlet-class>
</servlet>

<servlet>
    <servlet-name>view-workspaceitem</servlet-name>
    <servlet-class>ac.ed.dspace.ViewWorkspaceItemServlet</servlet-class>
</servlet>

<servlet>
    <servlet-name>notes</servlet-name>
    <servlet-class>ac.ed.dspace.NotesServlet</servlet-class>
</servlet>


<!-- Servlet Mappings -->

<servlet-mapping>
    <servlet-name>supervise</servlet-name>
    <url-pattern>/admin/supervise</url-pattern>
</servlet-mapping>

<servlet-mapping>
    <servlet-name>view-workspaceitem</servlet-name>
    <url-pattern>/view-workspaceitem</url-pattern>
</servlet-mapping>

<servlet-mapping>
    <servlet-name>notes</servlet-name>
    <url-pattern>/notes</url-pattern>
</servlet-mapping>

  6. Go into [eul]/jsp/new/ and copy all the JSPs here into the dspace [dspace]/jsp/ directory. Note that the new files are directory structured in the same way as the corresponding JSPs in DSpace.
  7. Go into [eul]/jsp/update/. If you still have the default installation of dspace, you may copy the JSPs here into [dspace]/jsp/ as per step (6). If not, you will need to open the JSPs in this directory and move the code delimited by:

    ******* Start EUL Code Inclusion ********

    and

    ******* End EUL Code Inclusion ********

    into the corresponding DSpace JSP. If additional instructions are required, they will be detailed in the file itself. Note that the updated files are directory structured in the same way as the corresponding JSPs in DSpace.
  8. Restart Apache and Tomcat. The installation should now work. See the Documentation for more information. It may be necessary to remove Tomcat's cached files, located in work/ in the Tomcat directory.


Creating the JavaDocs

To create the Public API documentation for the EUL code, in the [eul] directory execute the following command:

ant public_api

This will build a directory: [eul]/public-api/ containing the documentation.