Installation

JRE prerequisites

JasperAssistant requires that you use at least version 5 of Java runtime environment (JRE). Older versions of JasperAssistant (< 3.1.0) can be used with JRE 1.4.2.

Prerequisites

Before you can install the JasperAssistant plug-in, please make sure that you have installed the following dependencies:

For Eclipse 3.5.x:

For Eclipse 3.4.x:

For Eclipse 3.3.x:

For Eclipse 3.2.x:

For Eclipse 3.1.x:

For Eclipse 3.0.x:

Support for Eclipse 2.1.x / WSAD 5.1.x

Since version 2.1.0, JasperAssistant requires Eclipse 3.0.x or Eclipse 3.1.x. Eclipse 2.1.x and WSAD 5.1.x are only supported by versions 2.0.5 or earlier of JasperAssistant.

Before you can install the JasperAssistant plug-in under Eclipse 2.1.x / WSAD 5.1.x, please make sure that you have installed the following software:

For Eclipse 2.1.3 / WSAD 5.1.2:

For Eclipse 2.1.2 / WSAD 5.1.1:

Download and install using Eclipse Update

JasperAssistant plug-in can be downloaded and installed using Eclipse Update. Please visit the JasperAssistant Update Site for more information.

Installing the plug-in

To install JasperAssistant you must perform the following steps:

  1. Stop the Eclipse IDE
  2. Unzip GEF installation archive into your Eclipse installation folder.
  3. Unzip JasperAssistant installation archive into your Eclipse installation folder.
  4. Start the Eclipse IDE

To verify that the installation was done properly you can check that the following directories exist:

  • <ECLIPSE_HOME>/features/com.jasperassistant.designer_3.1.1
  • <ECLIPSE_HOME>/plugins/com.jasperassistant.designer_3.1.1

Also check the existence of the following directories or files to ensure the correct installation of the GEF plug-in:

For Eclipse 3.5.x:

  • <ECLIPSE_HOME>/features/org.eclipse.gef_3.5.x.xxx
  • <ECLIPSE_HOME>/plugins/org.eclipse.gef_3.5.x.xxx.jar
  • <ECLIPSE_HOME>/plugins/org.eclipse.draw2d_3.5.x.xxx.jar

For Eclipse 3.4.x:

  • <ECLIPSE_HOME>/features/org.eclipse.gef_3.4.x.xxx
  • <ECLIPSE_HOME>/plugins/org.eclipse.gef_3.4.x.xxx.jar
  • <ECLIPSE_HOME>/plugins/org.eclipse.draw2d_3.4.x.xxx.jar

For Eclipse 3.3.x:

  • <ECLIPSE_HOME>/features/org.eclipse.gef_3.3.x.xxx
  • <ECLIPSE_HOME>/plugins/org.eclipse.gef_3.3.x.xxx.jar
  • <ECLIPSE_HOME>/plugins/org.eclipse.draw2d_3.3.x.xxx.jar

For Eclipse 3.2.x:

  • <ECLIPSE_HOME>/features/org.eclipse.gef_3.2.x.xxx
  • <ECLIPSE_HOME>/plugins/org.eclipse.gef_3.2.x.xxx.jar
  • <ECLIPSE_HOME>/plugins/org.eclipse.draw2d_3.2.x.xxx.jar

For Eclipse 3.1.x:

  • <ECLIPSE_HOME>/features/org.eclipse.gef_3.1.x
  • <ECLIPSE_HOME>/plugins/org.eclipse.gef_3.1.x.jar
  • <ECLIPSE_HOME>/plugins/org.eclipse.draw2d_3.1.x.jar

For Eclipse 3.0.x:

  • <ECLIPSE_HOME>/features/org.eclipse.gef_3.0.x
  • <ECLIPSE_HOME>/plugins/org.eclipse.gef_3.0.x
  • <ECLIPSE_HOME>/plugins/org.eclipse.draw2d_3.0.x

For Eclipse 2.1.x / WSAD 5.1.1/5.1.2:

  • <ECLIPSE_HOME>/features/org.eclipse.gef_2.1.x
  • <ECLIPSE_HOME>/plugins/org.eclipse.gef_2.1.x
  • <ECLIPSE_HOME>/plugins/org.eclipse.draw2d_2.1.x

Enabling the plug-in

If JasperAssistant plug-in does not appear to be accessible after the installation, then the plug-in may require to be enabled manually:

  • From the menu, select Help->Software Updates->Manage Configuration. In the Product Configuration Dialog, first make sure that Show Disabled Features is toggled to ON in the toolbar.
  • Now drill down in the Eclipse Platform tree view. Both the Graphical Editing Framework (GEF) and JasperAssistant need to be present (if not, they are not installed) and enabled.

It is possible that after this action the plug-in is still not accessible. This is due to a bug in Eclipse 3.0 that in certain cases prevents the plug-in from activating. In this case, simply delete the 'configuration' folder under the Eclipse installation root and restart the IDE. Note that this is a safe operation that does not affect any important configuration data. Alternatively, you can start Eclipse using the following command line:

eclipse -clean

Memory settings

The Preview Feature of JasperAssistant can consume a significant amount of memory depending on the size of your reports. It is recommended that you increase the default memory settings used when running Eclipse. The following line starts Eclipse with 512M for its memory allocation pool:

eclipse -vmargs -Xmx512m

When using a Sun VM, you may also need to increase the size of the permanent generation memory. The default maximum is 64 megabytes, but more may be needed depending on your plug-in configuration and use. The maximum permanent generation size is increased using the following command line:

eclipse -vmargs -XX:MaxPermSize=128

Starting with Eclipse 3.2, memory settings can be made in the eclipse.ini file that is located in Eclipse installation directory. Put the following options at the end of the eclipse.ini file, one option per line:


-vmargs
-XX:MaxPermSize=128m
-Xms40m
-Xmx512m

Using the plug-in

We strongly recommend that before you start using JasperAssistant, you also take a look at the F.A.Q section that answers several common questions.