upgrade.txt

/*
 * ============================================================================
 * GNU Lesser General Public License
 * ============================================================================
 *
 * Servoy - Smart Technology For Smart Clients.
 * Copyright � 1997-2010 Servoy BV http://www.servoy.com
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 * 
 * Servoy B.V.
 * De Brand 26
 * 3823 LJ Amersfoort
 * The Netherlands 
 * http://www.servoy.com
 */
GENERAL NOTES
In order to upgrade to the latest version of the JasperReports engine, please pay attention to the following:
- download the new engine from http://community.jaspersoft.com/project/jasperreports-library 
- download the JasperReports project archive from http://sourceforge.net/projects/jasperreports/files/jasperreports (or follow links from http://community.jaspersoft.com/project/jasperreports-library)
- please refer to one of the following two sections, according to the suitable situation. 


UPGRADE BASIC OR CHARTNSCRIPT PLUGIN VERSIONS
If you are using the Basic or the ChartNScript drop-in versions:
1. Upgrade the version of the JasperReports engine, in the /plugins/servoy_jasperreports directory with the desired one.
2. Check and synchronize the versions of the libraries used by Servoy with the ones used by JasperReports:
	2.1 In the current version of Servoy JasperReports plugin, which is 6.16.0 (that uses the JasperReports engine version 6.16.0), libraries are in sync with required Servoy versions.
	2.2 If you are upgrading from the previous version(s) of our plugin (4.x and below), make sure you have the new version of the needed libraries (pay special attention to POI and itext) at the corresponding locations.
	2.3 Please also refer to the wiki page of project for details: https://github.com/Servoy/servoy_jasperreports/wiki
		2.2.1 If more (complex) updates are needed, please double-check and synchronize the library versions of the following folders, in your servoy installation directory: /application_server/lib and application_server/plugins, with the ones used by the version of the JasperReports project you are upgrading to.
3. Edit the servoy_jasperreports.properties file, to point to the properly new copied library jars files, if any.


UPGRADE THE ADVANCED PLUGIN VERSION
If you are using the Advanced (configurable) version of the plugin:
1. Edit the servoy_jasperreports.properties file. 
	1.1 Specify the path to the JasperReports (extracted) project folder and to the JasperReports engine jar file (this path must end with the name of the jar file): pathToJasperReportsEngineJar=C:/Downloads/JasperReports/jasperreports-x.x.x.jar, pathToJasperReportsProject=C:/Downloads/JasperReports/jasperreports-x.x.x-project.
	1.2 The servoy_jasperreports.properties file contains records of all the libraries that might be required by the JasperReports engine. The properties file has been written with respect to JasperReports version 6.2.0. If using a different version of JasperReports, please verify and update the library record information if necessary (path, package, version, as found in the JasperReports project folder).
2. Generate the plugin files (required by Servoy), using ant and providing the configure.xml (contained in the present downloaded zip) as the argument: for example, start in the same folder where the configure.xml is located and run ant (C:/path/to/configure_xml/ant), if you have the "path" system variable pointing to the bin folder of the ant binaries, or start from the bin folder located in the ant binaries folder and run ant pointing to configure.xml (C:/path/to/ant_binaries/bin/ant -buildfile C:/path/to/configure_xml/configure.xml).  
	2.1 If you do not have ant installed, please download the binaries from http://ant.apache.org/bindownload.cgi and configure the system "path" variable to point to the bin folder of the ant binaries download.
	2.2 This step configures the plugin with a minimal set of required libraries and creates the necessary jnlp file (according to the properties specified in the servoy_jasperreports.properties file).
3. Copy the contents of the generated plugins folder (as the result of step 2) into the application_server/plugins/ folder of your Servoy installation folder.