Readme for JReport Products

Version 13.5 Update 2

JReport Designer

TABLE OF CONTENTS

I.	PROBLEM REPORTING
II.	INSTALLING AND RUNNING JREPORT DESIGNER
III.	JREPORT DESIGNER MANUAL
IV.	JREPORT UTILITIES
V.	BASIC TROUBLESHOOTING

I. PROBLEM REPORTING

Please report all problems to us by using the bug reporting form on the Jinfonet website: http://www.jinfonet.com/support/.

If you are having trouble using the bug reporting form on the web, you may report issues and make suggestions by email to support@jinfonet.com. Please provide us with the following:

1.	Your customer ID (if you have purchased this product) or your name and how you can be contacted by email, phone and fax.

2.	Run the batch file called "jrenv.bat" in the<install_root>\bin directory. Running this batch file will generate a file called "report.env" in the current directory. Send this file to us.

3.	A description on how to reproduce the problem.

4.	If possible, send us the catalog file (.cat and .fml) and the report file that you are having problem with.

5.	Start JReport with the option -vDebug -vError -log. The command should like this: JReport -vError -vDebug -log This command will generate the log file JReport.log in the <install_root>\logs directory. Try to reproduce the problem, and send this log file to us.

6.	Send us the data file. To generate the data file, in the Catalog Browser, right-click on the query that your report used, select the menu item 'Create Cached Query Result', then input the data file name.

We would also like to hear about any enhancements you would like to see in future versions of JReport Designer.

II. INSTALLING AND RUNNING JREPORT DESIGNER

The following instructions refer to <install_root>. Please replace with your actual installation directory such as C:\JReport\Designer.

To install JReport Designer:
-----------------------------------

1.	Download the JReport Designer installation file from the the Jinfonet download center: http://www.jinfonet.com/downloadjreport/.

2.	Run the file and follow the prompts to install.

3.	You will find shortcuts to start JReport Designer in the Start menu and on the Desktop on Windows.

Setup the Demo Data Source:
------------------------------------
JReport provides some sample reports in <install_root>\Demo\Reports\. The demo reports are based on HSQL DB using a built-in JDBC driver. You should be able to view them after installation.

To Run JReport Designer:
--------------------------------
You can run JReport Designer either using the shortcut created during installation or the batch file created by the setup program. To run the batch file, run JReport.bat on Windows or JReport.sh on Unix in <install_root>/bin.

III. JREPORT DESIGNER MANUAL

The JReport Designer manual is provided to guide you through the steps of creating reports. You can access the manual from the Jinfonet website: http://www.jinfonet.com/kbase.htm.

The manual is also installed on your hard disk at the path: <install_root>\help.

IV. JREPORT UTILITIES

You can find a set of utilities in the directory <install_root>\bin.


JReport.bat:
	Starts JReport Designer.

NJReport.bat:
	Starts JReport Designer without the jit option.

DJReport.bat:
	Starts JReport Designer and generate a log file.

CatDr.bat:
	Starts Catalog Doctor to make changes in the catalog.

EConvert.bat:
	Used to remove the evaluation mark from reports.

jrenv.bat:
	Generates the report environment file report.env to enable the Jinfonet support staff to assist you.

PropConvert.bat:
	Convert property values.

rp.bat:
	Use "rp UID Key" to install a new key without reinstalling the system.

UDOMaker.bat:
	User Defined Object maker to import beans.

ModelWizard.bat:
	Used to start ObjectDataSource importer.

V. BASIC TROUBLESHOOTING

Refer to this section if you are having problems running JReport Designer.

Please refer to http://www.jinfonet.com/faq/ for Frequently Asked Questions.

System requirements:

Minimum Designer Requirements

OS:	Windows, Unix, Linux
CPU:	Dual Core processor
Free Memory:	2 GB
Free Disk:	1 GB
JDK/SDK:	6 or above

Recommended Designer Requirements

OS:	Windows x64, Unix x64 and Linux x64
CPU:	Quad Core processor
Free Memory:	4 GB
Free Disk:	2 GB
JDK/SDK:	6 or above

Configure JDBC drivers. JReport Designer supports database connections via various JDBC drivers, and ODBC data sources via Sun's JDBC-ODBC bridge.

Note: You need to install the JDBC or ODBC driver before installing JReport if you want the installation to update the CLASSPATH automatically. You can add additional drivers at any time by updating the file setenv.bat/setenv.sh in <install_root>/bin. Refer to the appropriate JDBC or ODBC manuals for more information about how to install them.

You can specify JDBC drivers in two ways:


a.	Specifying JDBC driver's Java class name in the Connect dialog box.

b.	Edit <install_root>bin\jdbcdrivers.properties, in which one or more JDBC drivers can be specified: jdbc.drivers=foo.bah.Driver:wombat.sql.Driver

For additional information and the latest information about JReport Designer and other products from Jinfonet, visit our website http://www.jinfonet.com.

JReport Server

TABLE OF CONTENTS

PROBLEM REPORTING

II.

INSTALLING AND RUNNING JREPORT SERVER

III.

TROUBLESHOOTING

I. PROBLEM REPORTING

Please report all problems to us by using the bug reporting form on the Jinfonet website: http://www.jinfonet.com/support/.

If you are having trouble using the bug reporting form on the web, you may report issues and make suggestions by email to support@jinfonet.com. Please provide us with the following:

Your customer ID (if you have purchased this product) or your name and how you can be reached by email, phone and fax.

A description of your environment, including machine type, operating system CPU, memory, and Java version.

A description on how to re-create the problem. If possible, include a copy of your report/data file and any error messages.

Send us the log files.


a.	If you are running a standalone JReport Server, start JReport Server in the logging mode: <install_root>\bin\JRServer -logall

b.	If you are running JReport Server as a servlet, please add -Dlogall=true to the application server JVM arguments and restart the server. After that, reproduce your problem and send us the log files in <install_root>\logs.

We would also like to hear about any enhancements you would like to see in future versions of JReport Server.

II. INSTALLING AND RUNNING JREPORT SERVER

The following instructions refer to <install_root>. Please replace with your actual installation directory such as C:\JReport\Server.

To install JReport Server:
--------------------------------

1.	Download the JReport Server installation file from the Jinfonet download center: http://www.jinfonet.com/downloadjreport/.

2.	Run the file and follow the prompts to install. You will need to have a Java JDK or SDK installed prior to installing JReport Server.

Setup the Demo Data Source:
------------------------------------

JReport Server provides some sample reports in <install_root>\jreports. These sample reports are based on HSQL DB using a built-in JDBC driver. You should be able to view them after installation.

To Run JReport Server
-----------------------------

You can run JReport Server using either the Shortcut that was created during installation or the batch file created by the setup program. To run the batch file, run JRServer.bat on Windows or JRServer.sh on Unix in <install_root>/bin.

The default administrator account is:

User Name: admin
Password: admin

Use this account to login to JReport Server. Open a browser session and use the URL http://localhost:8888 for the JReport Console and http://localhost:8889 for JReport Administration.

III. TROUBLESHOOTING

Refer to this section if you are having problems running JReport Server.

1. Java JDK/SDK 6 or above is required to run JReport Server. We have not certified JReport Server on JDKs other than from Sun and IBM although customers are using JVMs from other vendors. Please report any problems you find to us.

2. System requirements:

Minimum Server Requirements

OS:	Windows, Unix, Linux, z/Linux
CPU:	Dual Core processor
Free Memory:	2 GB
Free Disk:	1 GB
JDK/SDK:	6 or above

Recommended Server Requirements

OS:	Windows x64, Unix x64, Linux x64, z/Linux64
CPU:	Quad Core processor
Free Memory:	8 GB
Free Disk:	10 GB
JDK/SDK:	6 or above

3. Configure JDBC drivers. JReport Server supports database connections via various JDBC drivers, and ODBC data sources via Sun's JDBC-ODBC bridge.

You can specify JDBC drivers in two ways:


a.	Specifying JDBC driver's Java class name in the Connect dialog box.

b.	Editing <install_root>\bin\jdbcdrivers.properties, in which one or more JDBC drivers can be specified: odbc.drivers=foo.bah.Driver:wombat.sql.Driver

4. These JAR files located in <install_root>\lib are covered by the Apache 2.0 license:

commons-collections-3.2.1.jar

commons-httpclient-3.0.jar

commons-logging-1.1.jar

commons-net-ftp-2.0.0.jar

dwr-1.1.3.jar

jasper-compiler.jar

jasper-runtime.jar

quartz-all-1.6.5.jar

stax-api-1.0.1.jar

wstx-asl-3.2.0.jar

5. The JavaScript file jquery-1.4.2.min.js located in <install_root>\public_html\javascript is under the license as shown at http://github.com/jquery/jquery/blob/master/MIT-LICENSE.txt.

6. In an integration environment, you may encounter the following problems:

a.	JReport Viewer and JReport Studio use many dynamic classes, so you may encounter "OutOfMemoryError: PermGen space" problem when working with them after JReport Server is integrated into an application server. To solve the problem, you need to add `-XX:MaxPermSize=256m` to the JVM or set the number to a bigger one according to your environment.

b.	After JReport Server is integrated into JBoss 5, you may encounter an engine compiling formula problem when running reports that says "LoadJavaFormulaException: The formulas in this catalog cannot be compiled". A way to deal with the issue is to extract the jreport.war in jboss_home/server/default/deploy to a folder named jreport.war. The solution is also applicable to a JReport Server EAR file.

7. About the uninstall of JReport Server.

There are these ways to uninstall JReport Server:

a. On Windows, remove JReport Server from the Control Panel, or run uninstaller.exe in <install_root>\_uninst.

b. On Unix, run uninstall in <install_root>/_uninst.

8. For additional information about JReport Server and other products from Jinfonet, please visit our website http://www.jinfonet.com.

JReport Server Monitor

TABLE OF CONTENTS

I.	INTRODUCTION
II.	PROBLEM REPORTING
III.	INSTALLING AND RUNNING JREPORT SERVER MONITOR
IV.	JREPORT SERVER MONITOR MANUAL
V.	BASIC TROUBLESHOOTING

I. INTRODUCTION

JReport Server Monitor is a standalone web-based application used to monitor the overall performance of JReport Server. It has the following main features: valign="top"


1.	Inspects the status of JReport Server.

2.	Shows the server performance statistics in GRAPH/TEXT mode.

3.	Maintains JReport Server.

4.	Creates profiling reports: performance reports and statistic reports.

5.	Manages the logs.

II. PROBLEM REPORTING

Please report all problems to us using the bug reporting form on the Jinfonet website: http://www.jinfonet.com/support/.

If you are having trouble using the bug reporting form on the web, you can always report problems and make suggestions by email to support@jinfonet.com. Please provide us with the following:


1.	Your customer ID (if you have purchased this product) or your name and how you can be contacted by email, phone and fax.

2.	The environment description, including machine type, CPU, memory, OS, Java version, etc.

3.	A description on how to re-create the problem. If possible, include a copy of your report/data file and any error messages.

4.	Send us the log files. The log files are under the logs folder in the installation root.

We would also like to hear about any enhancements you would like to see in future versions of JReport Server Monitor.

III. INSTALLING AND RUNNING JREPORT SERVER MONITOR

The following instructions assume that JReport Server Monitor is installed in C:\JReport\Monitor.

To install JReport Server Monitor:
------------------------------------------

1.	Download the JReport Server Monitor installation file from the Jinfonet download center: http://www.jinfonet.com/downloadjreport/.

2.	Run the file and follow the prompts to install.

3.	You can create a shortcut to the batch file created by the setup program. To do so, double-click to open My Computer, (C:), JReport, Monitor, and bin, then right-click MonitorServer.bat and select Create Shortcut.

4.	To install the Shortcut on the Desktop, drag and drop the Shortcut to the Desktop.

To Run JReport Server Monitor:
----------------------------------------

You can run JReport Server Monitor using either the Shortcut you created or the batch file created by the setup program. Please make sure JReport Server is started before launching JReport Server Monitor.

Use the server.properties file in C:\JReport\Monitor\bin to specify the admin server host name/ip and port.

The default administrator account is:

User Name: admin
Password: admin

First use this account to login JReport Server Monitor.

IV. JREPORT SERVER MONITOR MANUAL

JReport Server Monitor manual is provided to guide you through the steps of performing monitoring tasks. You can access the manual from the Jinfonet website: http://www.jinfonet.com/kbase.htm.

The manual is also installed on your hard disk at the path: C:\JReport\Monitor\help.

V. BASIC TROUBLESHOOTING

Refer to this section if you are having problems running JReport Server Monitor.

Java JDK/SDK 6 or above is required to run JReport Server Monitor. We have not tested JReport Server Monitor on VMs other than Sun's and IBM's, so the program's behavior is unpredictable. Please report any problems you have found to us.

System requirements:

Minimum Requirements

OS:	Windows, Unix and Linux
CPU:	Dual Core processor
Free Memory:	1 GB
Free Disk:	100 MB
JDK/SDK:	6 or above

Recommended Requirements

OS:	Windows x64, Unix x64 and Linux x64
CPU:	Quad Core processor
Free Memory:	2 GB
Free Disk:	1 GB
JDK/SDK:	6 or above

About the uninstall of JReport Server Monitor.

There are these ways to uninstall JReport Server Monitor:

On Windows, remove JReport Server Monitor from the Control Panel, or run uninstaller.exe in <install_root>\_uninst.

On Unix, run uninstall in <install_root>/_uninst.

For additional and latest information about JReport Server Monitor and other products from Jinfonet, please visit our website http://www.jinfonet.com.