EclipseLink Solutions Guide for EclipseLink
Release 2.4
  Go To Table Of Contents

Installing EclipseLink for Java SE and Java EE Development

Use the following procedures to install EclipseLink for Java SE and EE development. Before you proceed with the install, it is recommended that you back up any existing project data.

  1. Set the following system environment variables before installing EclipseLink:

    • JAVA_HOME - Set JAVA_HOME to where you installed your Java SDK home directory. For example:

      • Windows example: JAVA_HOME = C:\JDK

      • UNIX example: JAVA_HOME = ...:/usr/java/jdk

    • PATH - Set PATH to include JDK/bin directory. For example:

      • Windows example: PATH = C:\JDK\bin

      • UNIX example: PATH = ...:/usr/java/jdk/bin

  2. Download the EclipseLink install archive zip file,, from the EclipseLink downloads page at


    In addition to all the EclipseLink libraries, the archive includes EclipseLink Workbench, a graphical interface that allows you to configure descriptors and map projects using native (pre-JPA) object-relational mapping, object-XML mapping (MOXy), and Enterprise Information System (EIS) usage.

    Workbench is provided for users of those older native APIS, and it is useful for migrating from native EclipseLink (see Chapter 7, "Migrating from Native TopLink"). However, it is recommended that you use an IDE with support for current versions EclipseLink, for example Dali (see

  3. Unzip the downloaded file in the desired installation directory. When you unzip the file, you will find an eclipselink subdirectory, containing multiple subdirectories. This directory is your new ECLIPSELINK_HOME directory. For example:

    • Windows example: ECLIPSELINK_HOME = <INSTALL_DIR>/eclipselink

    • UNIX example: ECLIPSELINK_HOME = ...:/usr/el/INSTALL_DIR/eclipselink

  4. If you want to use EclipseLink Workbench, additional steps are required. See "Configuring the Workbench Environment" at