-
Notifications
You must be signed in to change notification settings - Fork 0
/
install.txt
71 lines (61 loc) · 6.27 KB
/
install.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
* ============================================================================
* 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
*/
CONTENT:
Since the JasperReports engine has many optional dependencies and loading all possible dependency libraries in a Servoy plugin on all Servoy rich clients is expensive, it is required to configure the Servoy JapserReports plugin.
To configure, edit the servoy_jasperreports.propeties to tell what libraries should be included. The editing is described in the INSALLATION section in greater detail.
For a description of all the libraries JasperReports may require, please have a look at http://jasperforge.org/website/jasperreportswebsite/trunk/requirements.html.
The default configuration of library dependencies is as follows:
* Eclipse JDT Java Compiler: for report compilation
* Jakarta Commons Digester Component: XML-to-Java object mapping utility and its recommended dependency set of Jakarta Commons Logging and BeanUtils components
* iText: a free Java-PDF library (for report PDF output facility)
* Jakarta POI: for report XLS output facility
* JFreeChart and its required dependency, JCommon: for chart support
This zipfile contains the JasperReports plugin for Servoy, version 6.16.0.
It is to be used with Servoy 6.x and/or higher and is consistent with JasperReports version 6.16.0.
For more information about Servoy, visit http://www.servoy.com.
For more information about JasperReports, visit: http://community.jaspersoft.com/project/jasperreports-library.
INSTALLATION:
1. Download the JasperReports project archive file (zip or tar.gz) and the JasperReports engine jar file from the link mentioned above. Also please extract the contents of the JasperReports project archive into a folder of your choice.
2. Edit the servoy_jasperreports.properties file.
2.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), downloaded at step 1: pathToJasperReportsEngineJar=C:/Downloads/JasperReports/jasperreports-x.x.x.jar, pathToJasperReportsProject=C:/Downloads/JasperReports/jasperreports-x.x.x-project.
2.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 5.6.1. 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).
3. 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).
3.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.
3.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).
4. Copy the contents of the generated plugins folder (as the result of step 3) into the application_server/plugins/ folder of your Servoy installation folder.
DEPENDANCIES:
The plugin which has been configured in the previous section contains a minimal set of required libraries. If other libraries are required, look into the servoy_jasperreports.properties file and uncheck the names of the additionally required libraries. Then repeat steps 3-4 of the INSTALLATION section.
In the case of any conflicts between the servoy_jasperreports plugin libraries and the equivalent Servoy libraries, please replace the Servoy libraries with their equivalent version from the JasperReports project. When copying and replacing the new libraries in Servoy, please make sure their name matches the Servoy given names, so please rename the libraries after copying them.
DESIGN CLIENT (REPORT EDITOR):
As of JasperReports 5.5.0, JasperSoft Studio is the official design client for JasperReports. See http://community.jaspersoft.com/project/ireport-designer.
For more information about JasperSoft Studio refer to http://community.jaspersoft.com/project/jaspersoft-studio.
Please note that if using a JasperSoft Studio version lower than the version of the JasperReports engine, conflicts may arise due to the library versions used when building the report in JasperSoft Studio. In such cases, we recommend the updating of JasperSoft Studio to the equivalent version of the JasperReports engine.
Also please make sure, to avoid conflicts, that the library versions of the equivalent libraries used in Servoy, JasperReports and JasperSoft Studio are the same.
INFORMATION, FEATURE REQUESTS, BUG REPORTS:
https://www.servoyforge.net/projects/servoy-jasperreports