JASPERREPORTS SERVER COMMUNITY PROJECT INSTALLATION GUIDE

RELEASE 5.5

http://community.jaspersoft.com

JasperReports Server Installation Guide Copyright 2013 Jaspersoft Corporation. All rights reserved. Printed in the U.S.A. Jaspersoft, the Jaspersoft logo, Jaspersoft iReport Designer, JasperReports Library, JasperReports Server, Jaspersoft OLAP, and Jaspersoft ETL are trademarks and/or registered trademarks of Jaspersoft Corporation in the United States and in jurisdictions throughout the world. All other company and product names are or may be trade names or trademarks of their respective owners. This is version 1013-JSO55-30 of the JasperReports Server Community Project Installation Guide.

Table of Contents

TABLE OF CONTENTS
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1 1.2 1.3 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Java Version Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 JasperReports Server Distributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 1.3.1 1.3.2 1.4 1.5 1.6 Installer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 WAR File Binary Distribution Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Support for Internationalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 2 Installing JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

2.1 2.2 2.3 2.4 2.5 2.6 2.7 Pre-Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Starting the Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Accepting the License Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Choosing Installation Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Choosing an Installation Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Selecting a Tomcat Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Selecting a PostgreSQL Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 2.7.1 2.7.2 2.7.3 2.7.4 2.8 2.9 Choosing the Bundled PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Choosing an Existing PostgreSQL on a Local Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Using an Existing PostgreSQL on a Remote Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Enabling Connections to a Remote Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Installing Sample Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Completing the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 2.10.1 2.10.2 2.10.3 Updates Made by the Installer During Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Installer Output Log File Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Checking your Java JVM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.10 Post-Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

JasperReports Server Installation Guide

Chapter 3 Starting and Stopping JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

3.1 Start/Stop Menu Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 3.1.1 3.1.2 3.1.3 3.2 3.2.1 3.2.2 3.3 3.3.1 3.3.2 3.4 3.5 Start/Stop Menus Bundled Tomcat and PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Additional Information about the Bundled Tomcat and PostgreSQL . . . . . . . . . . . . . . . . . . 23 Start/Stop Scripts No Bundled Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Manual Start/Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Auto Start/Stop with Bundled Tomcat and PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Start/Stop Apps Mac Dock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Start/Stop JasperReports Server Mac Terminal Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Start/Stop Scripts Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Start/Stop Apps Mac OSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Logging into JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 JasperReports Server Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Chapter 4 Uninstalling JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

4.1 4.2 4.3 4.4 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Mac OSX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Uninstall Survey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Chapter 5 Installing the WAR File Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

5.1 Applications Supported by the WAR File Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 5.1.1 5.1.2 5.2 5.3 5.4 5.5 Database and Application Server Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Operating System Support for Bash Shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Installing the WAR File Using js-install Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Starting JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Logging into JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 5.4.1 5.5.1 5.5.2 5.5.3 5.5.4 JasperReports Server Heartbeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 JasperReports Server Startup Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Error Running a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Error Running js-install Scripts (js-install-ce.bat/sh) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Problem Connecting to a Cloud Database Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Troubleshooting Your JasperReports Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

5.6

Installing the WAR File Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 6 JVM Options, Manual Database Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

6.1 Setting JVM Options for Application Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 6.1.1 6.1.2 6.1.3 6.1.4 6.1.5 6.2 6.2.1 6.2.2 Tomcat and JBoss JVM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Changing JVM Options for Bundled Tomcat as a Windows Service . . . . . . . . . . . . . . . . . . 41 Changing JVM Options for Existing Tomcat as a Windows Service . . . . . . . . . . . . . . . . . . . 41 Changing JVM Options for Bundled Tomcat on Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Changing GlassFish JVM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 MySQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Manually Creating the JasperReports Server Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Table of Contents 6.3 Locating and Changing Buildomatic Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.3.6 6.3.7 6.3.8 6.3.9 6.3.10 6.4 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.5 Regenerating Buildomatic Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Locating Buildomatic-Generated Property Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Changing the JDBC Driver Deployed by Buildomatic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Buildomatic Location for JDBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Buildomatic Location for JasperReports Server WAR File . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Buildomatic Location for SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Buildomatic Location for Database Creation Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Buildomatic Location for Sample Data Catalog ZIP Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Hibernate Properties Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Database Connection Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Mail Server Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Database Settings for the Quartz Driver Delegate Class . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Settings for the Report Scheduler Web URI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Settings for the Quartz Table Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Settings for Import-Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Setting Properties in the default_master.properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Configuring Report Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Updating XML/A Connection Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Chapter 7 Upgrading from 5.2 to 5.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

7.1 7.2 7.3 7.4 7.5 Upgrade Steps Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Back Up Your JasperReports Server Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Preparing the JasperReports Server 5.5 WAR File Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Configuring Buildomatic for Your Database and Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . 56 7.4.1 7.5.1 7.5.2 7.5.3 7.6 7.6.1 7.6.2 7.7 7.7.1 7.7.2 7.7.3 7.8 Example Buildomatic Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 js-upgrade Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Output Log Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Clearing Your Browser Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Logging into JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Clearing the Application Server Work Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Clearing the Application Server Temp Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Clearing the Repository Cache Database Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Upgrading to JasperReports Server 5.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Starting and Logging into JasperReports Server 5.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Additional Tasks to Complete the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Old Manual Upgrade Steps: 5.2 to 5.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 8 Upgrading from 3.7 - 5.2 to 5.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

8.1 8.2 8.3 8.4 Upgrade Steps Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Planning Your Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Back Up Your JasperReports Server Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Exporting Current Repository Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 8.4.1 Using Buildomatic Scripts to Export Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

JasperReports Server Installation Guide 8.4.2 8.5 8.6 8.7 Using the js-export Script to Export Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Preparing the JasperReports Server 5.5 WAR File Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Configuring Buildomatic for Your Database and Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . 64 8.6.1 8.7.1 8.7.2 8.7.3 Example Buildomatic Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 js-upgrade Test Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Output Log Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Clearing Your Browser Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Logging into JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Handling JasperReports Server Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Clearing the Application Server Work Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Clearing the Application Server Temp Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Clearing the Repository Cache Database Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Upgrading to JasperReports Server 5.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

8.8

Starting and Logging into JasperReports Server 5.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 8.8.1 8.8.2

8.9

Additional Tasks to Complete the Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 8.9.1 8.9.2 8.9.3 8.9.4

8.10 Old Manual Upgrade Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Chapter 9 Planning Your Upgrade from 4.7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

9.1 9.2 Understanding the Changes in 4.7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Migrating Ad Hoc Reports to Ad Hoc Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 9.2.1 9.2.2 9.3 9.3.1 9.3.2 9.3.3 9.4 9.5 9.6 9.4.1 Changes to Ad Hoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Output of Migration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Banner and Toolbar Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Changes to IE Overrides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Images in JasperReports Server 4.7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Using Data Snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Upgrading Themes in 4.7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Data Snapshots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Understanding the Changes in 5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Upgrading Preserving Custom Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 10 Upgrading JasperServer 3.5 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

10.1 Upgrading from 3.5 or Earlier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 10.2 Best Practices for Upgrading under Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Chapter 11 Password Encryption in JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

11.1 Backing Up Your JasperReports Server Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 11.2 Stopping Your Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 11.3 Running the Repository Export Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 11.4 Specifying Encryption Settings in the JasperReports Server WAR . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 11.4.1 Specifying Encryption Settings - Reference Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 11.5 Specifying Encryption Settings for the Import Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 11.6 Recreating the JasperReports Server Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 11.6.1 Dropping and Recreating the Database in PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Table of Contents 11.6.2 11.6.3 Dropping and Recreating the Database in MySQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

11.7 Starting the Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 11.8 Logging into JasperReports Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Chapter 12 Configuring the Import-Export Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

12.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 12.2 Import-Export Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 12.3 Changing Your Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 12.3.1 12.3.2 12.3.3 12.3.4 Creating a default_master.properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Location of Properties Files and JDBC Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Checking the js.jdbc.properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Checking the js.quartz.properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

12.4 Adding an Additional JDBC Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 12.5 Running Import or Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 12.5.1 12.5.2 12.5.3 12.5.4 Running Import or Export from the UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Running Import from Buildomatic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Running Export from Buildomatic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Running the Import-Export Shell Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Appendix A Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
A.1 Binary Installer Freezes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 A.1.1 A.1.2 A.2 A.2.1 A.2.2 A.2.3 A.2.4 A.3 A.4 A.5 A.6 A.7 Installer Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Installer DebugTrace Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Missing Java JDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Forgot to Copy the File ant-contrib.jar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Failure with '$' Character in Passwords in Buildomatic Scripts . . . . . . . . . . . . . . . . . . . . . . 94 Older Apache Ant Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Error Running Buildomatic Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Unable to Edit Files on Windows 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Bash Shell for Solaris, IBM AIX, HP UX and FreeBSD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Linux Installer Issue with Unknown Host Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Installation Error with Windows Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Mac OSX Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 A.7.1 A.7.2 Problem Starting JasperReports Server on Mac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Installation Error on Mac OSX 10.8 (Lion) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Database Connectivity Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Case Sensitive Collation in SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Maximum Packet Size in MySQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Case Sensitivity for Table and Column Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 PostgreSQL: Job Scheduling Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Oracle js-install Script Hangs with Oracle 10g . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Performance Issues with Oracle JDBC Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Using an Oracle Service Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

A.8

Database-related Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 A.8.1 A.8.2 A.8.3 A.8.4 A.8.5 A.8.6 A.8.7 A.8.8

JasperReports Server Installation Guide A.8.9 A.8.10 A.8.11 A.9 A.9.1 A.9.2 A.9.3 A.9.4 A.9.5 A.9.6 A.9.7 A.9.8 A.9.9 A.9.10 A.10.1 A.11.1 Oracle Error on Upgrade when PL/SQL Not Enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Error Running Scheduled Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Error Running a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Memory Issues Running Under Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Java Out of Memory Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Configuration File Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Context.xml under Tomcat: Special Case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Tomcat 6 Installed Using apt-get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 GlassFish Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 JBoss Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Websphere Modifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Disabling User Session Persistence in Application Servers . . . . . . . . . . . . . . . . . . . . . . . . 107 Session Error Using JasperReports Server and Tomcat 7 . . . . . . . . . . . . . . . . . . . . . . . . . 108 Exporting a Repository That Contains UTF-8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Include Audit Events on Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Application Server-related Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

A.10 Problems Importing and Exporting Data from the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 A.11 Problems with Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 A.12 Installing on Windows XP if Memory Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 A.13 Property File Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 A.13.1 Owasp.CsrfGuard.properties - Security File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 A.14 Permissions Error in Overlay Upgrade with PostgreSQL and Bundled Jaspersoft Installation . . . . . 111

Introduction

CHAPTER 1

INTRODUCTION

JasperReports Server builds on JasperReports as a comprehensive family of Business Intelligence (BI) products, providing robust static and interactive reporting, report server, and data analysis capabilities. These capabilities are available as either stand-alone products, or as part of an integrated end-to-end BI suite utilizing common metadata and provide shared services, such as security, a repository, and scheduling. The server exposes comprehensive public interfaces enabling seamless integration with other applications and the capability to easily add custom functionality. The heart of the Jaspersoft BI Suite is the server, which provides the ability to:

Efficiently and securely manage many reports. Interact with reports, including sorting, changing formatting, entering parameters, and drilling on data. Schedule reports for distribution through email and storage in the repository. For business intelligence users, Jaspersoft offers Jaspersoft OLAP, which runs on the server. Jaspersoft provides several other sources of information to help extend your knowledge of JasperReports Server:

Our Ultimate Guides document advanced features and configuration. They also include best practice recommendations and numerous examples. The guides are available as downloadable PDFs. Community project users can purchase individual guides or bundled documentation packs from the Jaspersoft online store. Commercial customers can download them freely from the support portal. Our free Business Intelligence Tutorials let you learn at your own pace, and cover topics for developers, system administrators, business users, and data integration users. The tutorials are available online from the Professional Services section of our website. Free samples installed with JasperReports, and JasperReports Server, are documented online in the Community Wiki. For more information, visit our community website. Conventions Java Version Supported JasperReports Server Distributions Release Notes System Requirements Support for Internationalization

This chapter contains the following sections:

JasperReports Server Installation Guide

1.1

Conventions
Convention
<js-install>

This document uses the following conventions when referring to file locations: Description
The root directory where JasperReports Server will be installed. For manual installations, the directory where you unpack the WAR file distribution. <glassfish> <java> <jboss> <postgresql> <tomcat> The directory where GlassFish is installed. The directory where java is installed. The directory where JBoss is installed. The directory where PostgreSQL is installed. If you use the instance of PostgreSQL that is bundled by the installer, <postgresql> is located in the <js-install> directory. The directory where Apache Tomcat is installed. If you use the instance of Tomcat that is bundled by the installer, <tomcat> is located in <js-install>.

1.2

Java Version Supported

JasperReports Server supports Java 1.6 and 1.7. Versions earlier than Java 1.6 are not supported. JasperReports Server is tested and certified using Oracle/Sun Java. OpenJDK 1.6 has also been certified to run with JasperReports Server.

1.3

JasperReports Server Distributions

Distribution Package
Installer WAR File Distribution Zip

There are two main distribution packages for JasperReports Server. Description
Runs on Windows, Linux, and Mac OSX (32 or 64 bit). Used for manual installation on Windows, Linux, Mac, and other platforms.

The installer distribution package installs JasperReports Server, automatically configures the JasperReports Server database, and, if you choose the Install Sample Data option, installs sample data for working with tutorials. The WAR file binary distribution contains the JasperReports Server web archive file as well as scripts to create and load the database. The WAR file distribution supports additional applications that are not supported by the installers.

1.3.1

Installer Support

The installers support the following operating systems (32 and 64 bit): Platform
Linux

Versions supported
Red Hat Enterprise Linux 5, 6 Novell SUSE Linux Enterprise 10, 11 Debian 6 Ubuntu 10

10

Introduction Platform
Mac OSX

Versions supported
10.6 (Snow Leopard) 10.7 (Lion)

Windows

XP Windows 2008 Windows 7 Windows 8

1.3.1.1

Installer Naming for 32-bit and 64-bit

Native 32- and 64-bit installers are supported. The 64-bit installer will put 64-bit versions of Java 7 and PostgreSQL 9 onto your system for increased speed and performance. The installer file naming distinguishes the 32-bit installer from the 64-bit installer. Installer Type
32-bit installer

Naming
jasperreports-server-cp-5.5.0-windows-x86-installer.exe jasperreports-server-cp-5.5.0-linux-x86-installer.run

64-bit installer

jasperreports-server-cp-5.5.0-windows-x64-installer.exe jasperreports-server-cp-5.5.0-linux-x64-installer.run jasperreports-server-cp-5.5.0-osx-x64-installer.app.zip

Note: x86 is shorthand referring to the 386, 486, and 586 CPU architecture.

Note: You can install the 32-bit installer onto a 64-bit operating system, but we recommend that you install the 64-bit installer onto a 64-bit system. The 64-bit installer will not execute on a 32-bit system. 1.3.1.2 Installer Distribution Components

The installer is designed to get JasperReports Server up and running quickly. The server requires the Java environment, an application server, and database to run. The installer distribution bundles these components: Component
JasperReports Server Application JasperReports Server Documentation Apache Tomcat 7 Java 1.7 Runtime PostgreSQL 9 Database

Description
WAR file and configuration support scripts. Found in the <js-install>/docs directory. Web application container. You can use the bundled version or an existing version. Runs the web application container. Database server. You can use the bundled version or an existing version.

1.3.1.3

Installing with Existing Components

You can choose to deploy the bundled application or if you have existing components, the installer can deploy to these components. Both Apache Tomcat and the PostgreSQL database can be independently used as bundled or existing instances. If you would like the installer to install Tomcat, choose the bundled Tomcat. If you already have Tomcat on your computer you can choose an existing Tomcat.
If you use an existing Tomcat, it must be on the local machine.

11

JasperReports Server Installation Guide If you use an existing PostgreSQL, it can be on a local or remote machine. If its on a remote Linux machine, configure PostgreSQL to allow remote connections as described in 2.7.4, Enabling Connections to a Remote Host, on page 19. For information about specific versions of third party applications supported by the installer, refer to the JasperReports Server release notes in the root of the installation directory. 1.3.1.4 Running Components as Windows Services

The Windows installer installs PostgreSQL and Tomcat as Windows Services. Users can manage JasperReports Server under the Windows operating system using Services in the Control Panel:
Control Panel > System and Security > Administrative Tools > Services

The bundled PostgreSQL and Tomcat applications restart automatically when the host Windows system restarts. If you do not want to run these components to automatically restart, you can change the Startup Type from automatic to manual. You can find the PostgreSQL and Tomcat services under the following names:

jasperreportsPostgreSQL jasperreportsTomcat

You can also start JasperReports Server from the Windows Start menu.

1.3.2

WAR File Binary Distribution Support

Use the WAR file binary distribution package to install the JasperReports Server application if you cannot use the installer. The WAR file supports more applications than the installer. If you want to use a database other than PostgreSQL and an application server other than Apache Tomcat, install JasperReports Server using the WAR file.
For a complete list of applications supported by the WAR file distribution, refer to the release notes that are included in the root directory of the distribution.

The target database can be on a remote server. Using a remote PostgreSQL database on some Linux platforms requires a change to its configuration file, as described in section 2.7.4, Enabling Connections to a Remote Host, on page 19. The application server should reside on the local machine. There are js-install shell scripts (for Linux and Window) included in the WAR file distribution which automate much of the installation tasks by using a single properties file. These scripts are named:

js-install-ce.bat js-install-ce.sh

The main contents of the WAR file binary distribution are: Content Item
JasperReports Server js-install scripts JasperReports Server Database Scripts JasperReports Server Documentation JasperReports Server Extra Samples JasperReports Server Standard Sample Data JasperReports Server WAR file archive

Description
Found at <js-install>/buildomatic/js-install-ce.bat and js-install-ce.sh. SQL scripts for each supported database. Guides for end users and administrators. Web Service example applications, sample reports, custom data source examples, and other sample files. Sample data that highlights JasperReports Server features. All of the JasperReports Server class files and dependent jars.

12

Introduction 1.3.2.1 About Bundled Apache Ant

The War File Distribution ZIP comes with a bundled version of Apache Ant so you do not need to download or install Ant. The buildomatic Ant scripts come with Windows and Linux batch scripts that are pre-configured to use the bundled version of Apache Ant. The buildomatic Ant scripts are called from the command line in the following manner: Windows:
js-ant <target-name>

Linux and Mac OSX: ./js-ant <target-name> The bundled Apache Ant is version 1.8.1. This version or higher is required if you want to run your own version of Ant. The bundled Apache Ant has an additional jar that extends Ant functionality. This jar is: ant-contrib.jar. This jar enables conditional logic in Ant. If you are running your own Ant you should copy the ant-contrib.jar to your Ant/lib folder.
On Linux and Solaris, the js-ant commands may not be compatible with all shells. If you have errors, use the bash shell explicitly. For more information, see section A.4, Bash Shell for Solaris, IBM AIX, HP UX and FreeBSD, on page 95.

1.4

Release Notes

Release notes are included with each distribution and with each new update to a distribution. Not all applications are immediately supported when a new JasperReports Server version is released. For instance, some applications require additional testing beyond what is completed for the initial General Availability (GA) release. To find out exactly what applications are supported with a particular distribution refer to the release notes found in that distribution.

1.5

System Requirements

The following table contains the minimum and recommended resources for a full installation that includes PostgreSQL and an application server. The values are based on our own testing. You may find that JasperReports Server can run on systems with fewer resources or slower systems than stated in the minimum resources column. At the same time, it is possible to run out of resources with the recommended configuration. The success of your deployment depends on the intended load of the system, the number of concurrent users, the data sets, and whether the databases are installed on the same system as the JasperReports Server. Resource
Disk RAM Processor

Footprint
~1.3 Gigabytes

Minimum
10GB free 4GB 2 core minimum

Recommended
40GB + 8GB + 2.5GHz + multi-core Pentium for Windows, Mac, and Linux

Note on Windows XP: The maximum RAM that can be addressed on a 32 bit machine is about 3.5 Gigabytes. So, for a Windows XP installation this amount of memory is the minimum required for JasperReports Server. If you install to Windows XP using the binary installer please see Troubleshooting Section A.10 Installing to Windows XP for more information.

1.6

Support for Internationalization

JasperReports Server supports the full Unicode character set using UTF-8 encoding. It also depends on the underlying database and application server to support the UTF-8 character encoding. If you use the bundled Tomcat and PostgreSQL software, UTF-8 is configured by default. If you use any other software, refer to the JasperReports Server Administrator Guide for instructions about configuring software to support UTF-8.

13

JasperReports Server Installation Guide

14

Installing JasperReports Server

CHAPTER 2

INSTALLING JASPERREPORTS SERVER

This chapter contains the following sections: Pre-Installation Steps Starting the Installer Accepting the License Agreement Choosing Installation Type Selecting a Tomcat Configuration Selecting a PostgreSQL Configuration Installing Sample Data Completing the Installation Post-Installation Steps

2.1

Pre-Installation Steps

When you run the installation executable, you are given the option to install a bundled Apache Tomcat application server and PostgreSQL database or to use an existing Tomcat and PostgreSQL.
If you want to use an existing database instance, the database must be running at install time. If you want to use an existing Apache Tomcat, the Tomcat instance should be stopped.

If you choose to install the bundled Tomcat and database, both are installed on the same host with the server.
The bundled installer is not meant for use in Enterprise Production environments.

2.2

Starting the Installer

In Windows, the installer is an executable file that you can double-click to run. The installer under Windows will need a user account with Administrative privileges. The installer should also be started and run with Run as administrator. For example, right click on the binary installer file to bring up the context menu. Choose Run as administrator:
jasperreports-server-cp-5.5.0-windows-x86-installer.exe jasperreports-server-cp-5.5.0-windows-x64-installer.exe (32 bit) (64 bit)

15

JasperReports Server Installation Guide

The Windows installer will get an error installing the PostgreSQL database if the Windows user does not have sufficient Administrative privileges and if the installer is not started by right-clicking to use Run as administrator.

In Linux, the installer is a .run file; you can run it from the command line or from a graphical environment. To start the installer from the command line, open a bash shell, and enter the name of the installer file. For example:
./jasperreports-server-cp-5.5.0-linux-x86-installer.run ./jasperreports-server-cp-5.5.0-linux-x64-installer.run (32 bit) (64 bit)

In Mac OSX, the installer is a .zip file. Typically, after download, the installer will be found in your <user>/Downloads folder, and it will already be unpacked. After the download is complete, double-click the following:
jasperreports-server-cp-5.5.0-osx-x64-installer.app (64 bit Only)

Whether you run the installer from the command line or in a graphical environment, you are prompted for the same information. The following sections describe these prompts, and assume you are in a graphical environment. If you are installing from the command line, use your keyboard to specify the same details. For example, with the license text, instead of clicking I accept the agreement, you press Y and press Enter. The welcome screen introduces the installer and allows you to continue or exit. Click Next.

If you are installing a 32-bit installer onto a 64-bit operating system you will normally get a popup message reminding you that a 64-bit installer is available. It is not recommended to install a 32 bit version of JasperReports Server on a 64 bit machine. There can be Java memory usage problems particularly under Windows.
The Windows installer will get an error installing the PostgreSQL database if the Windows user does not have sufficient Administrative privileges and if the installer is not started by right-clicking to use Run as administrator.

2.3

Accepting the License Agreement

You are prompted to read and accept the license agreement. Read the agreement, agree to the terms by clicking I accept the agreement, and click Next. On the command line, you must page through several screens of text to read the full agreement. If you do not accept the agreement, you must exit the installer.

2.4

Choosing Installation Type

As of the 5.5.0 Release, the installer has been updated to offer a choice of Install Type. The first option will install all installer components and sample data resources. The second option is the Custom Install. With the custom install, you can choose which components to install and whether to include sample data resources. Install All Components and Samples Option This option will copy a Bundled version of the Apache Tomcat package and a Bundled version of the PostgreSQL database to your file system. Additionally, all sample data resources (Reports, Data Sources, OLAP Views, etc) are added to your JasperReports Server and additional sample databases are created. With this install option, the installer will attempt to find open Tomcat ports in the 8080 and higher range. And for the PostgreSQL port, the installer will start with port 5432 and then try values higher than this if 5432 is already being used. After you choose this first option, you can next choose the installation directory for JasperReports Server. Then, next, all files and components can be installed without requiring any further information. Custom Install

16

Installing JasperReports Server With the custom install, you will have the same choices that the installer has had in the past: install a Bundled Tomcat or use an Existing Tomcat, install a Bundled PostgreSQL or use an Existing PostgreSQL, choose ports for Tomcat and PostgreSQL, and choose whether to install sample data resources or not.

2.5

Choosing an Installation Directory

You are prompted for the directory where JasperReports Server is installed, referred to as the <js-install> directory. Accept the default or click Browse and select a different location, and click Next. On the command line, press Enter to accept the default. To choose a different directory location, enter that location at the prompt. The default <js-install> directory depends on your operating system: Windows: Linux: Linux (as root) Mac OSX
C:\Jaspersoft\jasperreports-server-cp-5.5.0 <USER_HOME>/jasperreports-server-cp-5.5.0 /opt/jasperreports-server-cp-5.5.0 /Applications/jasperreports-server-cp-5.5.0

On Linux, choose a <js-install> path thats no more than 84 characters.

2.6

Selecting a Tomcat Configuration

JasperReports Server requires an application server in order to run. The installer is pre-configured to run with the Apache Tomcat server. When you run the installer, two options appear on Setup Please select the Tomcat configuration you want to use:

I want to use the bundled Tomcat

If you choose this option, the installer puts an instance of Tomcat 6 onto your system. Later, after choosing a bundled or existing database, you are prompted for the server port and shutdown port that Tomcat will use. Most users accept the default values that are displayed. Accept the default values or enter alternate values, then click Next.

I want to use an existing Tomcat

If you already have an instance of Tomcat on your system, you can choose this option. Later, after choosing a bundled or existing database, you are prompted for the location of Tomcat. You can browse to the folder where you installed Tomcat, such as C:\Apache Software Foundation\Tomcat 7. After selecting a PostgreSQL configuration, you are prompted for Tomcat's server port and shutdown port. Accept the default values, 8080 and 8005 by default, or enter alternate values.

2.7

Selecting a PostgreSQL Configuration

JasperReports Server requires a database in order to run. The installer is pre-configured to run with the PostgreSQL database. There are two options available for your PostgreSQL database:

I want to use the bundled PostgreSQL database I want to use an existing PostgreSQL database

2.7.1

Choosing the Bundled PostgreSQL

If you choose the option to install the bundled PostgreSQL, the installer puts PostgreSQL 9 onto your system. The default PostgreSQL port 5432 will be used. If the installer finds that port 5432 is already in use, you are prompted to pick an alternate port. In this case, choose an alternative port value. The installer sets the PostgreSQL administrator password to postgres and also creates a PostgreSQL database user with administrator privileges and credentials of jasperdb/password.

17

JasperReports Server Installation Guide The following table summarizes the parameters set during installation of the bundled PostgreSQL: Parameter
Binary Directory Port IP or Host Name PostgreSQL Administrative Password

Default Value and Description

The directory where the postgres and pgAdmin3 binaries are located. The port number that PostgreSQL uses (default is 5432). User must choose an alternate port if 5432 is in use. The IP address or name of the machine where PostgreSQL is installed. The default value is 127.0.0.1. Password of the database administrative user: postgres. The installer cannot handle special characters at the end of a password string. Incompatible characters include: & ; $ Hard coded default: jasperdb - The installer creates this user which is used to connect to the JasperReports Server database Hard coded default: password - The installer uses this password for the jasperdb user. If your Linux installation does not have a locale setting that supports UTF-8 encoding, your Bundled PostgreSQL instance will be initialized using a temporary locale (--locale=C). This will allow the PostgreSQL initdb to succeed with the desired UTF-8 database encoding.

Database User Name Database User Password Additional notes for Linux

2.7.2

Choosing an Existing PostgreSQL on a Local Host

If you choose the option to use an existing PostgreSQL database, you are eventually prompted for the location of PostgreSQL and the port to use. If you have an instance of PostgreSQL installed locally, accept the default, which is 127.0.0.1, the localhost. Accept the default location for the PostgreSQL \bin directory, or click Browse to locate and select another location. You are also prompted for the default administrative account password of the PostgreSQL administrative user. The database administrative user account name postgres is used by default. Enter the database administrative user password and click Enter.
If the installer displays an error message saying FATAL: password authentication failed for user postgres, try re-entering the administrative password for your PostgreSQL database.

The following table summarizes the parameters set during the installation of an existing PostgreSQL: Defaults Used
PostgreSQL Administrative User Name jasperserver Database User Name jasperserver Database User Password

Hardcoded Default Values Used or Created

postgres - The default administrative database user. jasperdb - The installer creates this database user which is used to connect to jasperserver database. password - The installer creates this password for the jasperdb database user.

To improve system security, Jaspersoft recommends that you change the default password for jasperdb as soon as possible. To change the jasperdb connection password in JasperReports Server, edit: <js-install>/ apache-tomcat/jasperserver/META-INF/context.xml. (And delete, if it exists: <js-install>/apache-tomcat/conf/ Catalina/localhost/jasperserver.xml.) Then, make the same change in PostgreSQL using pgAdmin III or psql.

2.7.3

Using an Existing PostgreSQL on a Remote Host

If you are installing to a remote instance of PostgreSQL, you need the PostgreSQL client tools on your local machine. The version of client tools should match the remote PostgreSQL version. You can check the version of PostgreSQL instance by entering this command on the computer where its installed:

18

Installing JasperReports Server

psql --version

or
<path-to-postgresql-bin-folder>/psql --version

For instance: C:/Jaspersoft/PostgreSQL/9.0/bin/psql --version

To verify that you can connect to the target remote PostgreSQL from the local installation machine:

1. 2.

If necessary, install PostgreSQL client tools on your local, JasperReports Server machine. Using your local PostgreSQL client tools, enter this command:
psql -U postgres -h <remote-host> -d postgres

or
<path-to-postgresql-bin-folder>/psql -U postgres -h <remote-host> -d postgres

You might also need to enable connections as described in the next section.

2.7.4

Enabling Connections to a Remote Host

On most platforms, the default PostgreSQL installation doesnt allow remote connections (as a security feature). You need to enable remote connections as described in this documentation:

The PostgreSQL configuration documentation on the PostgreSQL web site The \docs directory of your PostgreSQL installation

To enable connections from the installation machine to the remote PostgreSQL server:

1.

Locate the following PostgreSQL host-based authentication (hba) configuration file on the remote PostgreSQL server instance: Windows: C:\Program Files\PostgreSQL\9.0\data\pg_hba.conf Linux: /var/lib/pgsql/data/pg_hba.conf

2.

Add the IP address of your local JasperReports Server installation machine to this file. For example, to allow the local installation machine with address 192.168.12.10 to connect to the PostgreSQL server, add this entry to the pg_hba.conf file:
host all 192.168.12.10/32 trust

3.

Allow TCP/IP connections to the remote PostgreSQL server instance by making the following change to the postgresql.conf file on the remote machine: From: listen_addresses = 'localhost' To: listen_addresses = '*'

4. 5.

Restart PostgreSQL. Using your local PostgreSQL client tools, verify that you can connect to the target remote PostgreSQL from the local installation machine, as described in section 2.7.3, Using an Existing PostgreSQL on a Remote Host, on page 18.

2.8

Installing Sample Data

JasperReports Server can be installed with sample databases and sample reports for evaluating its features. Included are: Sugar CRM data that simulates three years of operations for a fictitious company that relies on the SugarCRM open source application. Foodmart data that simulates three years of operations for a fictitious company. JasperReports Server repository resources such as Reports, OLAP Views, Data Sources, and Input Controls. Jaspersoft strongly recommends that you install this data, unless you are not interested in testing or evaluating with the default sample data.
Would you like to install sample databases and sample reports?

During installation, the following prompt appears:

19

JasperReports Server Installation Guide Click Yes to install the sample data, and click Next.

2.9

Completing the Installation

After the files have been installed, you see the final installation screen. There are several post-installation options:
View Release Notes - If you choose to view the release notes, you must exit the release notes text viewer before

JasperReports Server will launch and open a browser (if you have chosen that option below). Launch JasperReports Server Now - If you choose to launch JasperReports Server from the installer, the installer exits and the application server starts if you chose the bundled Tomcat and PostgreSQL. A pause that lasts approximately 25 seconds occurs as the server starts up, then the login page appears in your system default browser. If youre installing under Linux, do not close the terminal window running the start script. For information about logging in, see section 3.4, Logging into JasperReports Server, on page 26.
The Launch JasperReports Server Now check box option will only be displayed if you have chosen to install a bundled Tomcat and a bundled PostgreSQL. The menu based start/stop scripts only control the bundled applications that you chose to be installed. For more information, see Chapter 3, Starting and Stopping JasperReports Server, on page 23. Additionally, if you do not choose to Launch JasperReports Server Now the bundled components will not be started. If you only have one bundled component this component will not be started unless you use the Start/Stop menus or scripts. To Start and Stop JasperReports Server see Chapter 3, Starting and Stopping JasperReports Server, on page 23.

Opt-in for JasperServer Heartbeat - When the heartbeat is enabled, the server sends anonymous system and version

information to Jaspersoft using https. JasperReports Server heartbeat information helps Jaspersoft create better products by improving our understanding of customer installation environments. For more information, see section 5.4.1, JasperReports Server Heartbeat, on page 35. Make your choices, then click Finish. You should now be ready to log into the server.

2.10
2.10.1

Post-Installation Steps
Updates Made by the Installer During Installation

This section lists the standard updates that the installer makes to your local environment if you install to existing applications. When the installation completes, you can check that the updates, or corresponding changes, were successful.
Updates made to the application server

If you installed to an existing Tomcat, the following modifications to the Tomcat environment were attempted: File or Directory
Windows: bin/setenv.bat Linux and Mac OSX: bin/setevn.sh

Updates
Creates this file. Sets increased Java memory allocation values to JAVA_OPTS. For additional settings, refer to section 6.1, Setting JVM Options for Application Servers, on page 39. Adds PostgreSQL JDBC driver to this directory. As of 5.1, add additional JDBC drivers for other databases.

Tomcat 5: common/lib Tomcat 6 and 7: lib

20

Installing JasperReports Server

Updates made to the PostgreSQL database

If you installed to an existing PostgreSQL database, new schemas and users are created in your database instance: PostgreSQL Updates
Database jasperserver created

Description
This is the JasperReports Server repository database. This database holds all of system information, such as users, roles, datasources, and report definitions. The JasperReports Server application uses this user to connect to the database. (optional) Database created if install sample data option was chosen. (optional) Database created if install sample data option was chosen.

Database user jasperdb created Sample database foodmart created Sample database sugarcrm created

2.10.2

Installer Output Log File Location

The installer creates a log during installation that records information as the installation progresses. If you encounter any problems when you install JasperReports Server, it can be helpful to look at the installer log. You can find the installer log at <js-install>/installation.log.

2.10.3

Checking your Java JVM Options

For both the bundled Tomcat and the existing Tomcat, the installer attempts to set Java JVM options to help with memory allocation. You can double-check the values set to see that they are appropriate for your installation. If you installed a bundled version of Tomcat from the installer, these are the default Java JVM options for heap memory allocation: Installer Type
32 bit (x86) Windows

Setting
-Xms512m -Xmx1024m -XX:MaxPermSize=512m

File Location
<js-install>/apache-tomcat/bin/service.bat

32 bit (x86) Linux and Mac OSX

-Xms512m -Xmx1024m -XX:MaxPermSize=512m

<js-install>/apache-tomcat/scripts/ctl.sh

64 bit (x64) Windows

-Xms1024m -Xmx2048m -XX:MaxPermSize=512m

<js-install>/apache-tomcat/bin/service.bat

64 bit (x64) Linux and Mac OSX

-Xms1024m -Xmx2048m -XX:MaxPermSize=512m

<js-install>/apache-tomcat/scripts/ctl.sh

Note on Windows XP: On a Windows XP installation you may need to decrease the JAVA_OPTS memory settings. Otherwise, you might receive an Out of Memory error which you would see inside the <js-install>/apache-tomcat/ logs/catalina.out log file. If you are installing to Windows XP, please see section A.12, Installing on Windows XP if Memory Error, on page 110 for more information.

21

JasperReports Server Installation Guide

22

Starting and Stopping JasperReports Server

CHAPTER 3

STARTING AND STOPPING JASPERREPORTS SERVER

This chapter contains the following sections: Start/Stop Menu Windows Start/Stop Scripts Linux Start/Stop Apps Mac OSX Logging into JasperReports Server JasperReports Server Log Files

3.1

Start/Stop Menu Windows

This section describes different start and stop procedures depending on how you installed JasperReports Server: using the bundled Tomcat and PostgreSQL or using an existing Tomcat and PostgreSQL.

3.1.1

Start/Stop Menus Bundled Tomcat and PostgreSQL

If you chose to install a bundled Tomcat and a bundled PostgreSQL with JasperReports Server, use the Windows Start menu items to start and stop JasperReports Server.
To start or stop JasperReports Server from the Windows Start menu:

Click Start > All Programs > JasperReports Server > Start or Stop Services > Start Service. Click Start > All Programs > JasperReports Server > Start or Stop Services > Stop Service.

3.1.2

Additional Information about the Bundled Tomcat and PostgreSQL

JasperReports Server Windows Service Names:

The Windows Services Panel lists entries for PostgreSQL and Tomcat which are installed as Windows Services by the installer. These services are listed as:

jasperreportsPostgreSQL jasperreportsTomcat

Preventing JasperReports Server from starting up automatically:

By default, the bundled services are started automatically on a reboot. Consequently, the JasperReports Server also automatically starts. You can change the startup mode for the services from automatic to manual:

23

JasperReports Server Installation Guide

In the Windows Services Panel, select jasperreportsTomcat Right-click the jasperreportsTomcat service, and select properties Change the Startup type drop-down setting from Automatic to Manual Do the same for the jasperreportsPostgreSQL service

To Start JasperReports Server from the Windows Services Panel:

Open the Windows Services Panel Select jasperreportsPostgreSQL, click Start Select jasperreportsTomcat, click Start

To Start JasperReports Server from the CMD Shell:

JasperReports Server can be manually started from a Windows Command Shell:

Open a Windows CMD Shell Navigate to the root of the <js-install> folder (i.e. C:\Jaspersoft\jasperreports-server-cp-<ver>) servicerun START servicerun STOP (to shutdown JasperReports Server)

Running Processes:

When JasperReports Server is running, the Windows Task Manager lists information about the processes running under the SYSTEM user name:

postgres.exe tomcat7.exe

3.1.3

Start/Stop Scripts No Bundled Applications

During installation, if you chose to install one bundled and one existing Tomcat or PostgreSQL, you can use the Windows start/stop scripts to start and stop only the bundled one. For example, if you have an existing Tomcat and you install the bundled PostgreSQL, the scripts and menus specified in the previous section would start and stop the PostgreSQL application. To start and stop the existing Tomcat, you would use the management scripts provided by the Tomcat application.
JasperReports Server needs to have database and application servers started in this order:
First, start the database server. Next, start the application server.

3.2

Start/Stop Scripts Linux

This section describes different start and stop procedures depending on how you installed JasperReports Server: using the bundled Tomcat and PostgreSQL or using an existing Tomcat and PostgreSQL.

3.2.1

Manual Start/Stop

You typically start and stop JasperReports Server at the Linux command line. Run the following commands in a Linux shell. Start JasperReports Server:
cd <js-install> ./ctlscript.sh start

Stop JasperReports Server:

cd <js-install> ./ctlscript.sh stop

24

Starting and Stopping JasperReports Server To start and stop individual components:
cd <js-install> ./ctlscript.sh start|stop ./ctlscript.sh start|stop

postgresql tomcat

3.2.2

Auto Start/Stop with Bundled Tomcat and PostgreSQL

To have JasperReports Server automatically start when you reboot your Linux server, you need to install the JRS database and application server as services. If you have installed JasperReports Server using the binary installer with the bundled Tomcat and bundled PostgreSQL options, an example jasperserver service script can be found in the following location: <js-install>/scripts/linux/jasperserver Edit this script and set permissions as described in the <js-install>/scripts/linux/readme file in the same location. Once installed, these services are started automatically when you reboot. Consequently, the JasperReports Server also automatically restarts.

3.3

Start/Stop Apps Mac OSX

After you complete the Mac OSX installation, you typically find JasperReports Server installed in the following location: /Applications/jasperreports-server-cp-<ver> When JasperReports Server is running, you can see the names of the Java and PostgreSQL processes in the Activity Monitor. To start JasperReports Server, locate this folder in Finder and double-click the following app: jasperServerStart.app To stop JasperReports Server, locate this folder in Finder and double-click the following app: jasperServerStop.app The Mac lists the following information in the Activity Monitor:

java or org.apache.catalina.startup.Bootstrap

postgres

3.3.1

Start/Stop Apps Mac Dock

Using Finder, move the following apps into the Mac Dock to start, stop, and login to JasperReports Server: jasperServerStart.app jasperServerStop.app jasperServerLogin.app

3.3.2
1. 2. 3. 4.

Start/Stop JasperReports Server Mac Terminal Shell

To start and stop JasperReports Server using the Mac terminal shell:

Open a Terminal shell (Finder > Go > Utilities > Terminal Icon). Navigate to the <js-install> folder. For instance: /Applications/jasperreports-server-cp-<ver> To start PostgreSQL, Tomcat, and JasperReports Server, enter:
./ctlscript.sh start

To shutdown PostgreSQL, Tomcat, and JasperReports Server, enter:

./ctlscript.sh stop

25

JasperReports Server Installation Guide 5. To start and stop individual components:

cd <js-install> ./ctlscript.sh start|stop ./ctlscript.sh start|stop

postgresql tomcat

3.4
1. 2. 3.

Logging into JasperReports Server

To log into JasperReports Server on any operating system:

Start JasperReports Server. Open a supported browser: Firefox, Internet Explorer, Chrome, and Safari. Log into JasperReports Server by entering the startup URL in your browsers address field. The URL depends upon your application server. If you installed the default, bundled Tomcat use: http://<hostname>:8080/jasperserver

<hostname> is the name or IP address of the computer hosting JasperReports Server. 8080 is the default port number for the Apache Tomcat application server. If you used a different port when installing your application server, specify its port number instead of 8080.

The login page appears. 4. Log in using the following credentials: User ID
jasperadmin

Password
jasperadmin

Description
Administrator for the default organization

If you installed the sample data, these additional sample end-users are also created. These users are non-administrative users who have fewer system privileges than an administrative user. User ID
joeuser demo

Password
joeuser demo

Description
Sample end-user Sample end-user for the SuperMart Dashboard demonstration

When you complete the evaluation or testing of your JasperReports Server instance, change the administrator password (jasperadmin) and remove any sample end-users. Leaving the default passwords and end-users in place weakens the security of your installation. To log into JasperReports Server on Windows:

On Windows, you can launch the login page from the desktop of the JasperReports Server host computer by clicking Start >
All Programs > JasperReports Server > JasperReports Server Login. To log into JasperReports Server on Mac OSX:

On Mac OSX, you can launch the login page by going to Finder and clicking the following script: /Applications/<js-install>/jasperServerLogin For example: /Applications/jasperreports-server-cp-<ver>/jasperServerLogin
To use the Dock to log into JasperReports Server:

From Finder, you can drag the /Applications/<js-install>/jasperServerLogin.app to the Dock to handle logging into JasperReports Server using your default system browser.

26

Starting and Stopping JasperReports Server

3.5

JasperReports Server Log Files

Log files contain important information about JasperReports Server operations. If your application server is Tomcat, JBoss, or GlassFish, the log output goes to one of the following files: Tomcat: JBoss: <tomcat>/webapps/jasperserver/WEB-INF/logs/jasperserver.log <jboss>/server/default/deploy/jasperserver.war/WEB-INF/logs/jasperserver.log

GlassFish: <glassfish>/domains/domain1/autodeploy/jasperserver.war/WEB-INF/logs/jasperserver.log You can configure the log outputs and logging levels in the log4j.properties file in the WEB-INF folder.
To change the logging levels while you are running JasperReports Server:

1. 2.

Browse to http://<hostname>:8080/jasperserver/log_settings.html. The Log Settings page appears. Change logging levels using the drop-down menus. Changes to logging levels affect only the current session of JasperReports Server. Logging levels revert to default settings as defined in the properties files at the next startup.

For more information about system logging, see the JasperReports Server Administrator Guide.

27

JasperReports Server Installation Guide

28

Uninstalling JasperReports Server

CHAPTER 4

UNINSTALLING JASPERREPORTS SERVER

This chapter contains the following sections: Windows Linux Mac OSX Uninstall Survey

4.1

Windows

To uninstall JasperReports Server on Windows 7:

Click Start > All Programs > JasperReports Server > Uninstall JasperReports Server.
To uninstall JasperReports Server on Windows XP:

1. 2.

Click Start > All Programs > JasperReports Server > Uninstall JasperReports Server. Typically a popup window asks which user account to run as. Uncheck the check box that says: Protect my computer and data from unauthorized program activity
The uninstaller will not execute if Protect my computer and data from unauthorized program activity is checked.

4.2

Linux

Under Linux, the <js-install> folder includes an executable that removes JasperReports Server from the host.
To uninstall JasperReports Server:

1. 2.

From the command line, log in as the root user (or any user with sufficient privileges). Enter the following commands:
cd <js-install> ./uninstall

29

JasperReports Server Installation Guide 3. Respond Y or yes to the prompt that asks if you want to remove JasperReports Server from this computer.

4.3
1. 2.

Mac OSX

To use Finder to uninstall JasperReports Server:

Navigate to the <js-install> folder. For example: /Applications/jasperreports-server-cp-<ver> Click the uninstall.app to launch the uninstaller.

4.4

Uninstall Survey

After running the uninstaller, you are prompted to take an uninstall survey from Jaspersoft. Survey answers are anonymous and help Jaspersoft improve the products we make. When you click Yes, the survey launches on the Jaspersoft web site in a new browser window. Select all the reasons that led you to uninstall JasperReports Server, or enter a short explanation if none match. Thank you for your feedback.

30

Installing the WAR File Distribution

CHAPTER 5

INSTALLING THE WAR FILE DISTRIBUTION

In addition to the installer binaries, you can install the JasperReports Server application using the stand-alone WAR file distribution. For production environments, use the WAR file distribution. Download the WAR file distribution from http:// community.jaspersoft.com. The WAR file distribution comes in a file named jasperreports-server-cp-5.5.0-bin.zip in compressed ZIP format. This chapter contains the following sections:

Applications Supported by the WAR File Distribution Installing the WAR File Using js-install Scripts Starting JasperReports Server Logging into JasperReports Server Troubleshooting Your JasperReports Server Configuration Installing the WAR File Manually

5.1
5.1.1

Applications Supported by the WAR File Distribution

Database and Application Server Support

The instructions in this and subsequent chapters support the following configurations: Database
PostgreSQL MySQL

Application Server
Apache Tomcat JBoss GlassFish

Instructions Located In
This chapter.

For version information about these databases and application servers refer to the release notes in the root of the unpacked distribution ZIP.

31

JasperReports Server Installation Guide

5.1.2

Operating System Support for Bash Shell

JasperReports Server is a Java Web Application. Therefore, it supports all operating system platforms where Java is fully supported. However, for the js-install shell scripts (described in the section below), the default shell required is the bash shell. Here is a list of shells required: Operating System
Windows Linux Solaris IBM AIX HP UX FreeBSD

Required Shell for jsinstall scripts

CMD shell Bash shell Bash shell Bash shell Bash shell Bash shell

System Default Shell

CMD shell Bash shell Korn shell (ksh) Korn shell (ksh) Posix shell (posix/sh) C shell (tcsh)

Script to Run
js-install-ce.bat js-install-ce.sh js-install-ce.sh js-install-ce.sh js-install-ce.sh js-install-ce.sh

5.2

Installing the WAR File Using js-install Scripts

Follow the steps in this procedure to install JasperReports Server using WAR file distribution. The js-install shell scripts, supported on Windows, Linux, and Mac, do most of the work for you.
Prerequisites for installing the WAR file:

1. 2. 3.

Install the Oracle/Sun Java JDK 1.6 or 1.7. OpenJDK 1.6 has also been certified. Create and set the JAVA_HOME system environment variable to point to the Java JDK location. Locate or install one of the following application servers:

Apache Tomcat 5.5, 6, or 7 JBoss 5.1 or 7.1 Glassfish 2.1 or 3.0 using the default domain (domain1) If you use GlassFish 3.1.0 or a custom domain, see section A.9.6, GlassFish Modifications, on page 103.

4.

Locate or install the PostgreSQL or MySQL database.

The target database can be on a remote server. The application server should reside on the local machine.

If you would like to run a pre-install validation test, you can run js-install-ce.bat test or a similar command. For more information about how to perform a validation test in your environment, see section 5.5.3.1, js-install Script Test Mode, on
page 36. To install the WAR file using js-install scripts:

The scripts are intended for the bash shell.

If installing to non-linux Unix platforms such as HP-UX, IBM AIX, FreeBSD, or Solaris the bash shell is required for using the js-install scripts.

1.

Extract all files from jasperreports-server-cp-5.5.0-bin.zip. Choose a destination, such as C:\Jaspersoft on Windows, /home/<user> on Linux, or /Users/<user> on Mac. The directory, jasperreports-server-cp-5.5.0-bin, appears in the file location you choose. Copy the <database>_master.properties file for your database from sample_conf and paste it to buildomatic:

2.

Copy from <js-install>/buildomatic/sample_conf/

32

Installing the WAR File Distribution

Paste to <js-install>/buildomatic

For example, if your database is PostgreSQL, copy postgresql_master.properties to <js-install>/ buildomatic. 3. 4. Rename the file you copied to default_master.properties. Edit the default_master.properties file to add the settings for your database and application server. Table 5-1 lists sample property values for each supported database. Table 5-1 Database
PostgreSQL

Sample Values for the default_master.properties File Sample Property Values

appServerType=tomcat6 [tomcat7, tomcat5, jboss, jboss-eap-6, jboss-as-7, glassfish2, glassfish3, skipAppServerCheck] appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 7 dbHost=localhost dbUsername=postgres dbPassword=postgres

MySQL

appServerType=tomcat6 [tomcat7, tomcat5, jboss, jboss-eap-6, jboss-as-7, glassfish2, glassfish3, skipAppServerCheck] appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 7 dbUsername=root dbPassword=password dbHost=localhost

If, under Linux, Tomcat is installed using apt-get, yum, or rpm, see section A.9.5, Tomcat 6 Installed Using apt-get, on page 103. 5. Password Encryption

The default_master.properties file now has a property setting to enable encryption of passwords that reside on the file system. This will apply to all files found under the buildomatic folder. As well as the connection pooling file used by Apache Tomcat (i.e. context.xml). Currently, password encryption support for connection pooling only supports the Tomcat application server. To enable encryption on the file system, uncomment the encrypt property so that it looks like the following:
encrypt=true

For more information of the Encryption functionality, refer to the JasperReports Server Administrator Guide.

6.

Run the js-install scripts: a. b. c. d. Start your database server. Stop your application server. Open Command Prompt as Administrator on Windows or open a terminal window on Linux and Mac OSX. Run the js-install script: Description

Commands
cd <js-install>/buildomatic

33

JasperReports Server Installation Guide Commands

js-install-ce.bat (Windows) ./js-install-ce.sh (Linux and Mac OSX) js-install-ce.bat minimal (Windows) ./js-install-ce.sh minimal (Linux and Mac OSX)

Description
Installs JasperReports Server, sample data, and sample databases (foodmart and sugarcrm) Installs JasperReports Server, but does not install sample data and sample databases

If you encounter errors during the js-install script execution, see section 5.5.3, Error Running js-install Scripts (js-install-ce.bat/sh), on page 35. 7. Set Java JVM Options, as described in 6.1, Setting JVM Options for Application Servers, on page 39. This step is required.
To view the output log, look in: <js-install>/buildomatic/logs/js-install-ce-<date>.log

5.3

Starting JasperReports Server

To run JasperReports Server:

Start your application server using one of these commands: Tomcat: JBoss: GlassFish: Windows Linux and Mac OSX Windows Linux and Mac OSX Windows, Linux, and Mac OSX <tomcat>/bin/startup.bat <tomcat>/bin/startup.sh <jboss>/bin/run.bat <jboss>/bin/run.sh asadmin start-domain domain1

To view the JasperReports Server application logs, see section 3.5, JasperReports Server Log Files, on page 27.

5.4

Logging into JasperReports Server

After JasperReports Server starts up, login by going to this URL: http://<hostname>:8080/jasperserver Example: http://localhost:8080/jasperserver http://jasperserver.example.com:8080/jasperserver The login page appears after compiling the necessary JSP files (this will take a few moments). Use one of the following sets of credentials to log into JasperReports Server: User ID
jasperadmin

Password
jasperadmin

Description
Administrator for the default organization

If you logged in successfully, your JasperReports Server home page appears.

When you complete the evaluation or testing of your JasperReports Server instance, change the administrator password (jasperadmin) and remove any sample end-users. Leaving the default passwords and end-users in place weakens the security of your installation.

34

Installing the WAR File Distribution Refer to the JasperReports Server User Guide to begin adding reports and other objects to the server.

5.4.1

JasperReports Server Heartbeat

After initially logging into JasperReports Server, you are asked to opt-in to the JasperReports Server Heartbeat. To opt-in, click OK. To opt-out, click the check box to remove the check and click OK. The heartbeat helps Jaspersoft understand customer installation environments to improve our products. If you choose to enable the heartbeat, an HTTPS call at server startup time sends information like this to Jaspersoft:

Operating System and JVM type and version Application Server and Database type and version JasperReports Server type and version Unique, anonymous identifier value

You can manually enable or disable the heartbeat by modifying the following property file jasperserver/WEB-INF/ js.config.properties. To disable the heartbeat, set the heartbeat.enabled property to false:
heartbeat.enabled=false

For additional information about enabling and disabling the heartbeat component, see the JasperReports Server Administrator Guide.

5.5

Troubleshooting Your JasperReports Server Configuration

This section describes the most common installation problems.

5.5.1

JasperReports Server Startup Problems

If you encounter a problem trying to run a new JasperReports Server, an incorrect database configuration is the likely culprit. Another common cause is a mistake in the application server configuration files. For information about resolving these types of errors, see Appendix A, Troubleshooting, on page 93.

5.5.2

Error Running a Report

If you have trouble running reports in your new JasperReports Server instance, see section A.8.11, Error Running a Report in Appendix A, Troubleshooting, on page 93.

5.5.3

Error Running js-install Scripts (js-install-ce.bat/sh)

The js-install script creates an output log that captures standard output and error output. If you encounter problems during the execution of the script, or if you want to remember which options you chose, open the output log file.
To troubleshoot problems running js-install scripts:

1. 2.

Open the output log file located in:

<js-install>/buildomatic/logs/js-install-<date>-<number>.log

Try to find the first error encountered by the js-install steps.

Go to the end of the output log. Scroll back through lines of error messages until you find the first error logged. Typically, this error causes more errors later in the log. Finding the original error is the way to understand the problem. However, this can often be tricky because Java stack traces in conjunction with the Spring application component framework can make the error output quite long.

3.

Incorrect settings in the default_master.properties file cause most problems, which you can correct by editing your default_master.properties settings. Common errors are:

Typos in the path for the application server 35

JasperReports Server Installation Guide

Misspelling the hostname or password for the database

To recreate your default_master.properties settings:

1. 2.

Open the file <js-install>/buildomatic/default_master.properties, make corrections, and save it. Re-run the js-install script. The js-install script uses the current values in the default_master.properties file.

To help isolate errors, run the js-install scripts in test mode. 5.5.3.1 js-install Script Test Mode

You can run the js-install and js-upgrade scripts in test mode using the test option. In test mode, the js-install scripts check your default_master.properties settings and validate the application server location and connection to the specified database. Using test mode can help debug issues, such as an incorrect database password. Your system isnt altered when executing the script in test mode.
To run the js-install script in test mode on Windows:

1. 2.

Navigate to the buildomatic directory:

cd <js-install>/buildomatic

Enter the following command to run the js-install script in test mode:
js-install-ce.bat test

To run the js-install script in test mode on Linux or Mac OSX:

1. 2.

Navigate to the buildomatic directory:

cd <js-install>/buildomatic

Enter the following command to run the js-install script in test mode:
./js-install-ce.sh test

5.5.4

Problem Connecting to a Cloud Database Instance

A cloud database instance (such as Amazon EC2) typically disables unused IP ports. When the js-install script runs, it validates the database hostname using the built-in ant operation <isreachable>. This operation is similar to a network ping and may cause a hang issue if the port is unavailable. In this case, the validateHost step can be commented out in the buildomatic/validation.xml file. See the comment in the do-pre-install-test target.

5.6

Installing the WAR File Manually

In some case, you may need to install the WAR file manually when you cannot use the js-install scripts. The manual buildomatic steps described in this procedure execute the same Ant targets as the js-install scripts (js-install.sh/.bat). The procedure shows which buildomatic targets to execute manually if, for some reason, you are unable to use the js-install scripts.
To install the WAR file distribution using manual buildomatic steps:

1. 2. 3.

Start your database server. Stop your application server. Create and edit a default_master.properties file to add the settings in for your database and application server as described in 5.2, Installing the WAR File Using js-install Scripts, on page 32.

36

Installing the WAR File Distribution 4. Open a Command Prompt as Administrator on Windows or open a terminal window on Linux or Mac. Run the following commands: Table 5-2 Commands
cd <js-install>/buildomatic js-ant create-js-db js-ant create-sugarcrm-db js-ant create-foodmart-db js-ant load-sugarcrm-db js-ant load-foodmart-db js-ant init-js-db-ce js-ant import-minimal-ce js-ant import-sample-data-ce js-ant deploy-webapp-ce Initializes the jasperserver database, loads core application data. Running js-ant import-minimal-ce is mandatory. The server cannot function without this data. (Optional) Loads the demos that use the sample data. Configures and deploys the WAR file to Tomcat, JBoss, or Glassfish. (Optional) Loads sample data into the sample databases.

Buildomatic Targets to Execute to Install the WAR File Description

Makes the buildomatic directory your current directory. Creates the JasperReports Server repository database. (Optional) Creates the sample databases.

On non-Linux Unix platforms, the js-ant commands may not be compatible with all shells. If you have errors, use the bash shell explicitly. For more information, see section A.4, Bash Shell for Solaris, IBM AIX, HP UX and FreeBSD, on page 95.

If you encounter an error when running create-sugarcrm-db, create-foodmart-db, or create-js-db, you can create the JasperReports Server database manually using the database administration tool for your particular database type. To create the JasperReports Server database manually for PostgreSQL or MySQL, see section 6.2, Manually Creating the JasperReports Server Database, on page 43. If you have previously installed the databases, you can drop the old versions and then recreate the databases. To do this, run the following drop commands before running the commands in Table 5-2: Table 5-3 Commands
js-ant drop-sugarcrm-db js-ant drop-foodmart-db js-ant drop-js-db (WARNING) This will delete the JasperReports Server repository database. Only run this command if you intend to recreate the jasperserver database

Buildomatic Targets to Execute to Delete Sample Databases Description

(Optional) Deletes the sample databases.

5.

Set Java JVM Options, as described in section 6.1, Setting JVM Options for Application Servers, on page 39. This step is required.

37

JasperReports Server Installation Guide

38

JVM Options, Manual Database Creation

CHAPTER 6

JVM OPTIONS, MANUAL DATABASE CREATION

This chapter contains the following sections: Setting JVM Options for Application Servers asadmin start-domain domain1 Setting JVM Options for Application Servers Locating and Changing Buildomatic Configuration Files Configuring Report Scheduling Updating XML/A Connection Definitions

6.1

Setting JVM Options for Application Servers

JasperReports Server is supported on Java 1.6 and 1.7. Java Virtual Machine (JVM) runtime parameters normally need to be explicitly set so that the memory settings have values that are larger than the default settings. The options that you should set and the values they are set to depend on your version of Java and the application server that you use. The settings in this section apply specifically to the Oracle/Sun JVM. Other JVMs may or may not have equivalent settings.

6.1.1

Tomcat and JBoss JVM Options

The following tables present some typical settings of JVM options that affect JasperReports Server. For information about changing a JVM option setting for your particular environment, see your application server documentation.
The following example settings are for 64-bit systems. For 32-bit systems, see Checking your Java JVM Options on page 21.

39

JasperReports Server Installation Guide JVM Options on Windows (64 bit)

Options for Java 1.6 and 1.7 Additional options for Java 1.61.7 and JBoss Additional option for JBoss 5.1 set JAVA_OPTS=%JAVA_OPTS% -Xms1024m -Xmx2048m -XX:PermSize=32m set JAVA_OPTS=%JAVA_OPTS% -XX:MaxPermSize=512m -Xss2m -XX:+UseConcMarkSweepGC set JAVA_OPTS=%JAVA_OPTS% -XX:+CMSClassUnloadingEnabled
set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl

set JAVA_OPTS=%JAVA_OPTS% -Djavax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl

JasperReports Server doesnt provide a virtual X frame buffer on Linux. If your Linux applications are graphical, set the -Djava.awt.headless=true to prevent Java from trying to connect to an X-Server for image processing. JVM Options on Linux and Mac OSX (64 bit)
Options for Java 1.6 and 1.7 Additional options for Java 1.61.7 and JBoss Additional option for JBoss 5.1 export JAVA_OPTS="$JAVA_OPTS -Xms1024m -Xmx2048m -XX:PermSize=32m" export JAVA_OPTS="$JAVA_OPTS -XX:MaxPermSize=512m -Xss2m" export JAVA_OPTS="$JAVA_OPTS -XX:+UseConcMarkSweepGC" export JAVA_OPTS="$JAVA_OPTS -XX:+CMSClassUnloadingEnabled"
export JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl" export JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl" export JAVA_OPTS="$JAVA_OPTS -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl"

export JAVA_OPTS="$JAVA_OPTS -Djavax.xml.transform.TransformerFactory=org.apache.xalan.processor.TransformerFactoryImpl"

There are a number of ways to set JVM options. Sections 6.1.2 - 6.1.5 present step-by-step instructions for performing this task. Alternatively, you can add your JAVA_OPTS settings to any one of these files: File
<tomcat>/bin/setclasspath.bat <tomcat>/bin/setenv.bat <jboss>/bin/run.bat (JBoss 5.1) <jboss>/bin/standalone.bat (JBoss 7)

Add JVM Options After This Line on Windows

set JAVA_ENDORSED_DIRS=%BASEDIR%\common\endorsed JAVA_OPTS setting can go anywhere in this file. set JAVA_OPTS=%JAVA_OPTS% -Dprogram.name=%PROGNAME% rem Setup JBoss specific properties

File
<tomcat>/bin/setclasspath.sh <tomcat>/bin/setenv.sh <jboss>/bin/run.sh (JBoss 5.1) <jboss>/bin/standalone.sh (JBoss 7)

Add JVM Options After This Line on Linux

JAVA_ENDORSED_DIRS="$BASEDIR"/common/endorsed JAVA_OPTS setting can go anywhere in this file. export JAVA_OPTS="$JAVA_OPTS -Dprogram.name=$PROGNAME" Add JAVA_OPTS setting before #Display our environment

40

JVM Options, Manual Database Creation

6.1.2

Changing JVM Options for Bundled Tomcat as a Windows Service

The Windows binary installer installs the bundled Tomcat component as a Windows Service by default. The steps to change JVM options are: 1. 2. Open this file for editing:
cd <js-install>/apache-tomcat/bin/service.bat

Look for the following line to change the JVM heap size, for example:
"%EXECUTABLE%" //US//%SERVICE_NAME% --Startup auto --JvmOptions "-Xms1024M;Xmx2048M;-Xss2M;-Dcatalina.base=%CATALINA_BASE%;-Dcatalina.home=%CATALINA_HOME%;Djava.endorsed.dirs=%CATALINA_HOME%\endorsed" --StartMode jvm --StopMode jvm

3. 4.

Update this line to increase the maximum heap size from 2048M to 3072M, for example:
-Xmx3072M

Because Tomcat is installed as a service, you need to re-install the service. From a Windows Command shell, enter these commands (Note: the cmd shell will disappear when these commands are run. You need to open a new cmd shell for each command.). To open a cmd shell: Start Menu > Run... > cmd
cd <js-install>\apache-tomcat\scripts serviceinstall.bat REMOVE serviceinstall.bat INSTALL

The Tomcat service is removed and then installed. After execution of the commands, the service is running.

6.1.3

Changing JVM Options for Existing Tomcat as a Windows Service

If you installed JasperReports Server to use an existing Tomcat (not the bundled component) that is running as a Windows service, you can set Java options on the Java Tab of the Tomcat Properties dialog: 1. 2. 3. Launch the Tomcat configuration application from the Windows Start menu:
Start > Programs > Apache Tomcat > Configure Tomcat (Run as administrator)

In the Apache Tomcat Properties dialog, click the Java tab. In the Java Options field, add your JAVA_OPTS values according to the tables above. Enter only the options preceded by -X or -D, not set JAVA_OPTS=%JAVA_OPTS%. Enter only one Java option setting per line.

4.

For instance, add options as follows:

These example settings are for 64-bit systems. For 32-bit systems, see Checking your Java JVM Options on page 21.

-Xms1024m -Xmx2048m -XX:PermSize=32m -XX:MaxPermSize=512m -Xss2m

5. 6.

Click Apply, then click OK. Stop and restart Tomcat.

6.1.4

Changing JVM Options for Bundled Tomcat on Linux

If, under Linux, you installed JasperReports Server to use the bundled Tomcat, you can set Java options by editing the appropriate Tomcat configuration script. The steps to change JVM options are:

41

JasperReports Server Installation Guide 1. 2. 3. Open the following file for editing:
cd <js-install>/apache-tomcat/scripts/ctl.sh

Look for the start_tomcat() function and locate the JAVA_OPTS variable inside it. Modify the JAVA_OPTS values according to the tables above:
start_tomcat() { is_tomcat_running ... export JAVA_OPTS="-Xms1024m -Xmx2048m -XX:PermSize=32m -XX:MaxPermSize=512m Xss2m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled" ... }

There may be more than one occurrence of the Java_OPTS variable in the ctl.sh file. Make sure to edit the instance inside the start_tomcat() function.

4. 5.

Save and close the ctl.sh file. Stop and restart PostgreSQL and Tomcat as described in Chapter 3, Starting and Stopping JasperReports Server, on page 23.

6.1.5

Changing GlassFish JVM Options

The following sections describe how to set the JVM options for GlassFish for Java 1.6 and 1.7 using the command line or a configuration file. 6.1.5.1 1. Setting GlassFish JVM Options with asadmin Command

First make sure your GlassFish instance is up and running, then enter the following command as a single line:

asadmin create-jvm-options -Xms1024m:-Xmx2048m:-XX\:PermSize=32m: -XX\:MaxPermSize=512m:-Xss2m:-XX\:+UseConcMarkSweepGC: -XX\:+CMSClassUnloadingEnabled: -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl: -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl: -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl:

2.

Restart the application server using the following commands:

asadmin stop-domain domain1 asadmin start-domain domain1

When running the asadmin create-jvm-options command, error messages like this might appear:
[exec] CLI167 Could not create the following jvm options. Options exist: [exec] -Xmx512m [exec] CLI137 Command create-jvm-options failed.

This message indicates that one of the options specified was already set in the JVM. The command will succeed for all other JVM options on the command line. No further action is necessary. 6.1.5.2 1. Setting GlassFish JVM Options by Editing domain.xml

Open the <glassfish>/domains/domain1/config/domain.xml configuration file for editing.

42

JVM Options, Manual Database Creation 2. Add the following lines to the section entitled java-config:

<jvm-options>-Xms1024m -Xmx2048m -XX:PermSize=32m -XX:MaxPermSize=512m -Xss2 -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled -Djavax.xml.soap.MessageFactory=org.apache.axis.soap.MessageFactoryImpl -Djavax.xml.soap.SOAPConnectionFactory=org.apache.axis.soap.SOAPConnectionFactoryImpl -Djavax.xml.soap.SOAPFactory=org.apache.axis.soap.SOAPFactoryImpl </jvm-options>

3.

If you are modifying the settings for a running instance of GlassFish, restart the application server using the following commands:
asadmin stop-domain domain1 asadmin start-domain domain1

6.2

Manually Creating the JasperReports Server Database

If you cant use the js-install scripts to create the JasperReports Server database and the sample databases, you can create them manually.
To manually create the JasperReports Server database:

1.

Follow these instructions to create the repository database and optional sample databases:

6.2.1, PostgreSQL, on page 44 6.2.2, MySQL, on page 44 3., Continue from step 2 in section 6.2, "Manually Creating the JasperReports Server Database," on page 43., on page 45 3., Continue from step 2 in section 6.2, "Manually Creating the JasperReports Server Database," on page 43., on page 45 6.2.5, SQL Server, on page 47

The commands in these sections have been tested at Jaspersoft, but the commands you need to use on your database instance may be different. 2. If you did not install the optional sample databases, complete the installation with these commands:
cd <js-install>/buildomatic js-ant import-minimal-ce js-ant deploy-webapp-ce

If you installed the optional sample databases, complete the installation with these commands:
cd <js-install>/buildomatic js-ant import-sample-data-ce js-ant deploy-webapp-ce

For more information about executing the Ant scripts, see section 5.6, Installing the WAR File Manually, on page 36. 3. Set Java JVM Options, as described in section 6.1, Setting JVM Options for Application Servers, on page 39. This step is required.

43

JasperReports Server Installation Guide

6.2.1
1.

PostgreSQL

To manually create the JasperReports Server database in PostgreSQL:

On the Windows, Linux, or Mac command line, enter these commands to create and initialize the JasperReports Server database:
cd <js-install>/buildomatic/install_resources/sql/postgresql psql -U postgres -W postgres=#create database jasperserver encoding=utf8; postgres=#\c jasperserver; postgres=#\i js-create.ddl postgres=#\i quartz.ddl postgres=#\q

2.

(Optional) Run the following commands if you want to install sample databases:
cd <js-install>/buildomatic/install_resources/sql/postgresql psql -U postgres -W postgres=#create database sugarcrm encoding=utf8; postgres=#create database foodmart encoding=utf8; postgres=#\c sugarcrm; postgres=#\i sugarcrm.sql; (first make sure the file is unzipped) postgres=#\c foodmart; postgres=#\i foodmart-postqresql.sql; (first make sure the file is unzipped) postgres=#\i supermart-update.sql; postgres=#\q

3.

Continue from step 2 in section 6.2, "Manually Creating the JasperReports Server Database," on page 43.

6.2.2

MySQL

To manually create the JasperReports Server database in MySQL:

The MySQL client software, mysql.exe or mysql, can be used to interact with the MySQL database. For specific details on connecting to the MySQL database and setting privileges for databases and db users, please refer to the documentation provided with your database. 1. On the Windows, Linux, or Mac command line, enter these commands to create and initialize the JasperReports Server database:
cd <js-install>/buildomatic/install_resources/sql/mysql mysql -u root -p mysql>create database jasperserver character set utf8; mysql>use jasperserver; mysql>source js-create.ddl mysql>source quartz.ddl mysql>exit

44

JVM Options, Manual Database Creation 2. (Optional) Run these commands to install sample databases:
cd <js-install>/buildomatic/install_resources/sql/mysql mysql -u root -p mysql>create database sugarcrm; mysql>create database foodmart; mysql>use sugarcrm; mysql>source sugarcrm.sql;(first make sure the file is unzipped) mysql>use foodmart; mysql>source foodmart-mysql.sql; (first make sure the file is unzipped) mysql>source supermart-update.sql; mysql>exit

3.

Continue from step 2 in section 6.2, "Manually Creating the JasperReports Server Database," on page 43.

6.3

Locating and Changing Buildomatic Configuration Files

The Ant-based buildomatic scripts contain support files for setting up and configuring a number of databases and application servers. This section describes the locations and content of some of these files and how to change the content.

6.3.1

Regenerating Buildomatic Settings

Whenever you change your default_master.properties file and re-run the js-install scripts (or any other buildomatic target), your generated configuration settings are automatically updated. The generated settings are in this location:
<js-install>/buildomatic/build_conf/default

The settings are automatically regenerated based on the new timestamp found on the properties file. If you want to explicitly cause your generated configuration to be regenerated, you can run the following buildomatic targets:
cd <js-install>/buildomatic js-ant clean-config js-ant gen-config

The first target clears the configuration template files in buildomatic/build_conf/default directory. The second rebuilds the configuration settings.
These commands exist as a convenience. Whenever default_master.properties is edited, the resulting configuration templates are regenerated automatically based on the updated time-stamp associated with the edited file.

6.3.2

Locating Buildomatic-Generated Property Files

After you set your database and application server property values, you initiate buildomatic which automatically generates the database and application server configuration files needed to prepare for a JasperReports Server installation. The generated property files are in this location:
<js-install>/buildomatic/build_conf/default

Some of the key configuration files are:

js.jdbc.properties js.quartz.properties js-glassfish-ds.xml js-jboss-ds.xml maven_settings.xml - (used for source code build)

45

JasperReports Server Installation Guide More generated property files are:

<js-install>/buildomatic/build_conf/default/webapp

Included in the /webapp directory are configuration files, such as:

META-INF/context.xml WEB-INF/hibernate.properties WEB-INF/js.quartz.properties

These autogenerated files are removed if you run the buildomatic target: clean-config. You can then regenerate the files by running the target: gen-config. (Also, after running clean-config, any subsequent target will regenerate the configuration files.)

6.3.3

Changing the JDBC Driver Deployed by Buildomatic

When you run the buildomatic target deploy-webapp-ce the JDBC driver for your specified database is copied to your application server. If there is a different or more up-to-date JDBC driver that you prefer to use, change the driver used by updating your default_master.properties file:
<js-install>/buildomatic/default_master.properties

In default_master.properties, set the maven.jdbc.artifactId and the maven.jdbc.version to point to the name of the driver you would like to use:
maven.jdbc.artifactId=<first-part-of-filename> maven.jdbc.version=<version-part-of-filename>

Make sure that the property settings and the JDBC driver name exactly match, as shown in examples in the following sections. Put new JDBC drivers in the same location as the existing JDBC drivers for your DB type. The buildomatic scripts will look in the default jdbc folder location described in 6.3.4, Buildomatic Location for JDBC Drivers, on page 47 that is associated with your DB type:
<js-install>/buildomatic/conf_source/db/<dbType>/jdbc

If you plan to run the js-import-ce.bat/.sh, js-export-ce.bat/.sh shell scripts, manually update the JDBC driver version found in the <js-install>/buildomatic/conf_source/ieCE/lib folder. 6.3.3.1 PostgreSQL Driver Example

You can use the same logic above to deploy other JDBC drivers. For example, you want to use the JDBC3 PostgreSQL driver and automatically deploy the driver to your application server when you run the deploy-webapp-ce target. However, the default driver setting, shown in the following file, is JDBC4:
<js-install>/buildomatic/conf_source/db/postgresql/db.properties maven.jdbc.artifactId=postgresql maven.jdbc.version=9.2-1002.jdbc4

So the driver used is: postgresql-9.2-1002.jdbc4.jar To change the default driver setting, edit your default_master.properties file, add the following lines:
maven.jdbc.artifactId=postgresql maven.jdbc.version=9.2-1002.jdbc3

Now, when you run deploy-webapp-ce, the driver used is: postgresql-9.2-1002.jdbc3.jar. 6.3.3.2 MySQL Driver Example

You can use the same logic above to deploy other JDBC drivers. For example, you want to use the mariadb.jdbc driver and automatically deploy the driver to your application server when you run the deploy-webapp-ce target. To change the default driver settings, edit your default_master.properties file to use the following lines:
jdbcDriverClass=org.mariadb.jdbc.Driver maven.jdbc.groupId=org.mariadb.jdbc

46

JVM Options, Manual Database Creation

maven.jdbc.artifactId=mariadb-java-client maven.jdbc.version=1.1.2

6.3.4

Buildomatic Location for JDBC Drivers

The installer provides JDBC drivers for all databases listed in the following table: Database
PostgreSQL

Buildomatic JDBC Driver Location and Sample JARs

<js-install>/buildomatic/conf_source/db/postgresql/jdbc/postgresql-9.2-1002.jdbc3.jar <js-install>/buildomatic/conf_source/db/postgresql/jdbc/postgresql-9.2-1002.jdbc4.jar

MySQL Vertica (as a data source only)

<js-install>/buildomatic/conf_source/db/mysql/jdbc/mariadb-java-client-1.1.2.jar <js-install>/buildomatic/conf_source/db/vertica/jdbc/vertica_4.1.19_jdk_5.jar

6.3.5

Buildomatic Location for JasperReports Server WAR File

Buildomatic takes the JasperReports Server WAR file from the root of the <js-install> directory:
<js-install>/jasperserver.war

When you run the deploy-webapp-ce target, buildomatic takes the war archive and unpacks it into your application server. Next, the database configuration files needed by the application server are copied to the appropriate locations. For instance, in the case of Tomcat:

<js-install>/jasperserver.war Unpacked and copied to <tomcat>/webapps/jasperserver/* <js-install>/buildomatic/build_conf/default/webapp/META-INF/context.xml Copied to <tomcat>/webapps/jasperserver/META-INF/context.xml <js-install>/buildomatic/build_conf/default/webapp/WEB-INF/hibernate.properties Copied to <tomcat>/webapps/jasperserver/WEB-INF/hibernate.properties <js-install>/buildomatic/build_conf/default/webapp/WEB-INF/js.quartz.properties Copied to <tomcat>/webapps/jasperserver/WEB-INF/js.quartz.properties <js-install>/buildomatic/build_conf/db/postgres/jdbc/postgresql-9.2-1002.jdbc4.jar Copied to <tomcat>/lib

6.3.6

Buildomatic Location for SQL Scripts

Buildomatic comes with SQL scripts and other utilities that support a number of databases. These files are in: <js-install>/buildomatic/install_resources/sql/ For example, some key files are (same pattern for additional databases): <js-install>/buildomatic/install_resources/sql/postgresql/js-create.ddl <js-install>/buildomatic/install_resources/sql/postgresql/quartz.ddl <js-install>/buildomatic/install_resources/sql/postgresql/upgrade-postgresql-5.0.0-5.1.0-ce.sql <js-install>/buildomatic/install_resources/sql/postgresql/js-drop.ddl <js-install>/buildomatic/install_resources/sql/postgresql/drop-quartz.ddl
You can run these scripts manually by copying them to a location where your database client software is located.

47

JasperReports Server Installation Guide

6.3.7

Buildomatic Location for Database Creation Scripts

For most databases the buildomatic scripts are able to create the metadata repository database used by JasperReports Server. This is the database where the data defining users, roles, data sources, reports, OLAP views, domains, and other data are stored. This database is normally named jasperserver. Buildomatic attempts to create the jasperserver database via JDBC when the create-js-db target is executed. The scripts and property files used to create the jasperserver database are here: <js-install>/buildomatic/conf_source/db/ postgresql/scripts.properties mysql/scripts.properties

6.3.8

Buildomatic Location for Sample Data Catalog ZIP Files

Buildomatic includes export files which hold the JasperReports Server sample data (that have examples of new features). This sample data is loaded when you run the buildomatic target import-sample-data-ce, for instance. These export files along with other important export files are located here: <js-install>/buildomatic/install_resources/export/ Here are some key files (same pattern for additional databases): js-catalog-postgresql-minimal-ce.zip js-catalog-postgresql-ce.zip js-catalog-mysql-minimal-ce.zip js-catalog-mysql-ce.zip

6.3.9

Hibernate Properties Settings

Your hibernate.properties settings are in the following directory after buildomatic has been run to automatically generate your configuration files:
<js-install>/buildomatic/build_conf/default/webapp/WEB-INF/hibernate.properties

Within the jasperserver WAR file the hibernate.properties file is found at the following location:
<appserver-path>/jasperserver/WEB-INF/hibernate.properties

The buildomatic scripts automatically create this configuration file. When you run the buildomatic target deploy-webappce this file is copied to JasperReports Server in your application server. Hibernate property values are: PostgreSQL metadata.hibernate.dialect=com.jaspersoft.hibernate.dialect.PostgresqlNoBlobDialect MySQL 5.1 metadata.hibernate.dialect=org.hibernate.dialect.MySQLInnoDBDialect MySQL 5.5 metadata.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect

6.3.10
6.3.10.1

Database Connection Configuration Files

Tomcat

After setting up the buildomatic configuration for your database, the Tomcat context.xml will be automatically created with the appropriate settings for JasperReports Server. When the buildomatic target deploy-webapp-ce is run, the context.xml will be automatically copied into the jasperserver WAR set of files. You can view the automatically generated context.xml at the following location: <js-install>/buildomatic/build_conf/default/webapp/META-INF/context.xml The final location of the context.xml is:

48

JVM Options, Manual Database Creation <tomcat>/webapps/jasperserver/META-INF/context.xml Tomcat will often create a copy of the context.xml file with a changed name that will be read instead of the one found in the jasperserver war file. This is often a source of confusion for Tomcat users who attempt change their database settings. If you change your settings, delete the file in this location: <tomcat>/conf/Catalina/localhost 6.3.10.2 JBoss

After setting up the buildomatic configuration for your database, the JBoss data source definition file will be automatically created with the appropriate settings for JasperReports Server. When the buildomatic target deploy-webapp-ce is run, the js-jboss-ds.xml will be automatically copied into the JBoss instance. You can view the automatically generated js-jboss-ds.xml at the following location: <js-install>/buildomatic/build_conf/default/js-jboss-ds.xml (JBoss 5.1) <js-install>/buildomatic/build_conf/default/js-jboss7-ds.xml (JBoss 7.1) The final location of the js-jboss-ds.xml is: <jboss>/server/default/deploy/js-jboss-ds.xml (JBoss 5.1) <jboss>/standalone/deployments/jasperserver.war/WEB-INF/js-jboss7-ds.xml When JasperReports Server is running under JBoss, there are a couple of INFO log messages and an XML/A connection error that might occur depending on the version of JBoss you are running with. For more information, refer to troubleshooting section A.9.7, JBoss Modifications, on page 104. 6.3.10.3 Glassfish

After setting up the buildomatic configuration for your database, the Glassfish data source definition file js-glassfish-ds.xml will be automatically created with the appropriate settings. When the buildomatic target deploy-webapp-ce is run, the file is automatically deployed to the Glassfish instance. You can view the automatically generated js-glassfish-ds.xml at the following location: <js-install>/buildomatic/build_conf/default/js-glassfish-ds.xml To deploy the datasource definition manually, you can run a command similar to the following:
asadmin add-resources "<js-install>/buildomatic/build_conf/default/js-glassfish-ds.xml"

6.4

Configuring Report Scheduling

The JasperReports Server report scheduling feature is powered by the Quartz scheduler tool. The configuration settings for Quartz-based report scheduling is automatically handled by buildomatic. In a deployed JasperReports Server instance, you will find the js.quartz.properties file in the following location: <app-server-path>/jasperserver/WEB-INF/js.quartz.properties For mail server configuration, there is an additional property setting for authentication in the following file: <app-server-path>/webapps/jasperserver/WEB-INF/applicationContext-report-scheduling.xml There are four main configurations to be discussed in this section:

Mail Server Configuration Quartz Driver Delegate Class Report Scheduler Web URI Quartz Table Prefix Settings for import-export Setting Properties in the default_master.properties File

49

JasperReports Server Installation Guide

6.4.1

Mail Server Configuration Settings

If you schedule reports or run them in the background, you can specify email addresses to notify when the report completes. To use this feature, configure JasperReports Server to contact an email server: Configuration File
<app-server>/<deployment>/WEB-INF/js.quartz.properties

Property
report.scheduler.mail.sender.host report.scheduler.mail.sender.username

Description
The name of the computer hosting the mail server The name of the user in the mail server that JasperReports Server can use The password of the mail server user The address that appears in the From field on email notifications The protocol that the mail server uses. JasperReports Server only supports SMTP. Note: Your entry must be lower case. For example: smtp

report.scheduler.mail.sender.password report.scheduler.mail.sender.from

report.scheduler.mail.sender.protocol

report.scheduler.mail.sender.port

The port number that the mail server uses. For SMTP, the default is typically 25 (values other than 25 may not work in earlier JasperServer versions).

Configuration File
<app-server>/<deployment>/WEB-INF/applicationContext-report-scheduling.xml

Property
javaMailProperties key="mail.smtp.auth"

Bean
reportScheduler MailSender

Description
If your mail server requires authentication, change this property from false to true.

6.4.2

Database Settings for the Quartz Driver Delegate Class

Quartz uses the Quartz driver delegate class to interact with the JDBC driver.
If you used buildomatic to install JasperReports Server, the correct value of the Quartz driver delegate class is set automatically for your database.

If you didnt use buildomatic to install JasperReports Server, use this table to edit the js.quartz.properties file and set the value of the Quartz driver delegate class to the correct value for your database: Configuration File
<app-server>/<deployment>/WEB-INF/js.quartz.properties

Property
quartz.delegateClass

Database

Value

PostgreSQL

org.quartz.impl.jdbcjobstore.PostgreSQLDelegate

MySQL

org.quartz.impl.jdbcjobstore.StdJDBCDelegate

50

JVM Options, Manual Database Creation

6.4.3

Settings for the Report Scheduler Web URI

JasperReports Server uses the Report Scheduler Web URI to construct the link it sends in the output from a scheduled job. This link must be correct for the user to access the report on the server. The port on which you run JasperReports Server and context root of the deployed JasperReports Server web application determine the report scheduler Web URI. The default context root is jasperserver. To set this value manually, edit the following file: <app-server>/<deployment>/WEB-INF/js.quartz.properties. Change the properties for your application server as shown in the following table. Property
report.scheduler. web.deployment.uri

App Server
Apache Tomcat JBoss GlassFish

Example Value
http://localhost:8080/jasperserver http://localhost:8080/jasperserver http://localhost:8080/jasperserver

6.4.4

Settings for the Quartz Table Prefix

For databases that support schemas, such as PostgreSQL, you can set the Quartz table prefix so that it includes the schema if you use one.
If you installed JasperReports Server using buildomatic the Quartz table prefix is set automatically.

To set this value, edit the file <app-server>/<deployment>/WEB-INF/js.quartz.properties. Change the following property: Property
quartz.tablePrefix

Description
The prefix for the quartz table, including any schema name, for example JSPRSRVR.QRTZ_ for DB2.

6.4.5

Settings for Import-Export

If you are manually configuring the import-export shell scripts instead of using the buildomatic, make sure your settings for the Quartz driver delegate class property are correct for the database you are using.
If you installed using buildomatic these settings are handled automatically (in buildomatic import-export).

To configure the import-export scripts manually, edit the following file:

<js-install>/buildomatic/conf_source/ieCE/js.quartz.properties

Change the following properties: Property

quartz.delegateClass

Description
Set to the same value as described in section 6.4.2, Database Settings for the Quartz Driver Delegate Class, on page 50. Set to the same value as described in section 6.4.4, Settings for the Quartz Table Prefix, on page 51

quartz.tablePrefix

51

JasperReports Server Installation Guide

6.4.6

Setting Properties in the default_master.properties File

At installation time, there is a group of properties that can be set in order to configure JasperReports Server functionality. These properties are found in the default_master.properties file. They can be un-commented to set them to the nondefault values that will take effect upon installation. Look in the default_master.properties file for additional details. Your default_master.properties file should be found here:
<js-install>/buildomatic/default_master.properties

A sample master.properties can be found here (in the case of PostgreSQL):

<js-install>/buildomatic/sample_conf/postgresql_master.properties

When the js-install.sh/bat script is executed (or the underlying deploy-webapp-ce ant target), these properties will set into the deployed JasperReports Server in the js.quartz.properties file. 6.4.6.1 Report Scheduler Email Properties

As of Release 5.5, properties have been added that will set configuration for the Report Scheduler Email properties. The properties that can be set are the following (default values are shown):
quartz.mail.sender.host=mail.localhost.com quartz.mail.sender.port=25 quartz.mail.sender.protocol=smtp quartz.mail.sender.username=admin quartz.mail.sender.password=password [email protected] quartz.web.deployment.uri=http://localhost:8080/jasperserver

6.4.6.2

Diagnotic Properties

Properties which will set the configuration of the Diagnostic functionality:

diagnostic.jmx.usePlatformServer = false diagnostic.jmx.port = 10990 diagnostic.jmx.name = jasperserver diagnostic.jmx.rmiHost = localhost

Look at the descriptions of the properties in the default_master.properties file and also refer to the JasperReports Server Administrator Guide for more information on these settings.

6.5

Updating XML/A Connection Definitions

Sample XML/A connections are included with the JasperReports Server sample data. If you plan to use XML/A Web Services in your environment, then you may want to check and possibly update the hard coded values in the sample connections. If you have Jaspersoft OLAP enabled, JasperReports Server is able to make XML/A connections over the Web Services interface. These HTTP-based connections use a user account for authentication. You may have different usernames and passwords than the defaults that get loaded from the sample data load in the sections above. Additionally, your application server hostnames and port values might be different than the default values. In such cases, the connections and any other resources that rely on them will fail. There are two sample connections:

Foodmart Sample XML/A connection SugarCRM Sample XML/A connection Log into JasperReports Server as an administrator (such as jasperadmin). Navigate to the Repository Management page by selecting the View > Repository menu item.

If you would like to validate and update these resources, do the following: 1. 2.

52

JVM Options, Manual Database Creation 3. 4. Click to expand the Analysis Components folder, then the Analysis Connections folder. Click to highlight the Foodmart
XML/A Connection resource, then click Edit.

Edit the following information on this screen:

URI (hostname and port) Login Username Login Password

5. 6.

Click Next, then Save. Make the same updates for the SugarCRM XML/A Connection resource.

53

JasperReports Server Installation Guide

54

Upgrading from 5.2 to 5.5

CHAPTER 7

UPGRADING FROM 5.2 TO 5.5

This chapter describes how to upgrade from JasperReports Server 5.2 to JasperReports Server 5.5. The examples describe how to use the js-upgrade shell scripts to carry out the upgrade operation. This chapter contains the following sections:

Upgrade Steps Overview Back Up Your JasperReports Server Instance Preparing the JasperReports Server 5.5 WAR File Distribution Configuring Buildomatic for Your Database and Application Server Upgrading to JasperReports Server 5.5 Starting and Logging into JasperReports Server 5.5 Additional Tasks to Complete the Upgrade Old Manual Upgrade Steps: 5.2 to 5.5

7.1
1. 2. 3.

Upgrade Steps Overview

These are the general steps used in this section: Back up your current JasperReports Server instance. Download and set up the new 5.5 JasperReports Server WAR file distribution zip. Run the js-upgrade script as described in 7.5, Upgrading to JasperReports Server 5.5, on page 57.

If your current instance of JasperReports Server has any custom modifications or extensions, keep track of these and reintegrate them into your 5.5 instance after upgrading.

7.2

Back Up Your JasperReports Server Instance

First you must backup your JasperReports Server WAR file and jasperserver database so that they can be restored in case there is a problem with the upgrade. These steps are performed from the command line in a Windows or Linux shell. The following backup example is for Tomcat with the PostgreSQL or MySQL database. For other databases, consult your DB administration documentation for back up information.

55

JasperReports Server Installation Guide

Back up your JasperReports Server WAR File:

1. 2.

Create a folder location where you can save your jasperserver war file. For example, C:\JS_52_BACKUP or /opt/
JS_52_BACKUP.

Copy <tomcat>/webapps/jasperserver to <path>/JS_52_BACKUP

Back up your Jasperserver Database:

1. 2.

Create a folder location (if you did not do so in the step above) where you can save you jasperserver database, For example, C:\JS_52_BACKUP or /opt/JS_52_BACKUP. Run the following commands for PostgreSQL or MySQL:

PostgreSQL
cd <path>/JS_52_BACKUP pg_dump --username=postgres jasperserver > js-db-5.2-dump.sql

MySQL
cd <path>/JS_52_BACKUP

Windows: mysqldump --user=root --password=<password> jasperserver > js-db-5.2-dump.sql Linux:

mysqldump --user=root --password=<password> --host=127.0.0.1 jasperserver > js-db-5.2-dump.sql For MySQL, If you receive an error about packet size, see section A.8.3, Maximum Packet Size in MySQL, on page 99.

7.3

Preparing the JasperReports Server 5.5 WAR File Distribution

Use the buildomatic js-upgrade scripts included in the 5.5 WAR file distribution ZIP release package to carry out the upgrade. Follow these steps to obtain and unpack the WAR file distribution ZIP file: 1. 2. The WAR file distribution comes in a file named jasperreports-server-cp-5.5.0-bin.zip in the compressed ZIP format. Download the WAR file distribution from http://community.jaspersoft.com. Extract all files from jasperreports-server-cp-5.5.0-bin.zip. Choose a destination, such as a C:\Jaspersoft folder on Windows, /home/<user> on Linux, or /Users/<user> on Mac.
<js-install-5.5>

After you unpack the WAR File Distribution Zip, the resulting location will be known as:

7.4

Configuring Buildomatic for Your Database and Application Server

For Unix, the bash shell is required for the js-upgrade scripts. If you are installing to a non-Linux Unix platform such as HP-UX, IBM AIX, FreeBSD or Solaris, you need to download and install the bash shell. See Bash Shell for Solaris, IBM AIX, HP UX and FreeBSD on page 95 for more information.

This upgrade procedure uses the js-upgrade-samedb-ce shell script.

This section shows example configurations for the PostgreSQL and MySQL databases.

7.4.1

Example Buildomatic Configuration

The upgrade configuration is handled by the default_master.properties file. Jaspersoft provides a sample configuration file for each database. You must specify your database credentials and your application server location, and rename the file to default_master.properties.

56

Upgrading from 5.2 to 5.5 7.4.1.1 1. PostgreSQL Example

This example shows how to configure default_master.properties for PostgreSQL. Locate the postgresql_master.properties sample configuration file: Database
PostgreSQL

Master Properties File

<js-install-5.5>/buildomatic/sample_conf/postgresql_master.properties

2. 3. 4.

Copy the file to <js-install-5.5>/buildomatic Rename the file to default_master.properties Edit default_master.properties for your database and application server: Database
PostgreSQL

Sample Property Values

appServerType=tomcat6 [tomcat7, tomcat6, jboss, glassfish2, glassfish3] appServerDir=c:\\apache-tomcat-6.0.26 (for example) dbUsername=postgres dbPassword=postgres dbHost=localhost

7.4.1.2 1.

MySQL Example

This example shows how to configure default_master.properties for MySQL. Locate the mysql_master.properties sample configuration file: Database
MySQL

Master Properties File

<js-install-5.5>/buildomatic/sample_conf/mysql_master.properties

2. 3. 4.

Copy the file to <js-install-5.5>/buildomatic Rename the file to default_master.properties Edit default_master.properties for your database and application server: Database
MySQL

Sample Property Values

appServerType=tomcat6 [tomcat7, tomcat6, jboss, glassfish2, glassfish3] appServerDir=c:\\Apache Software Foundation\\Tomcat-6 (for example) dbUsername=root dbPassword=password dbHost=localhost

7.5

Upgrading to JasperReports Server 5.5

Make sure you have backed up your jasperserver database before proceeding. Make sure you have backed up your old JasperReports Server WAR file before proceeding.

Now that your buildomatic scripts have been configured, you can complete the upgrade.

1. 2.

Stop your application server Start your database server

57

JasperReports Server Installation Guide 3. Run the following commands: Commands

cd <js-install-5.5>/buildomatic js-upgrade-samedb-ce.bat (Windows) Upgrade jasperserver war file, upgrade jasperserver database to 5.5, add 5.5 repository resources into the database (Linux) Upgrade jasperserver war file, upgrade jasperserver database to 5.5, add 5.5 repository resources into the database

Description

./js-upgrade-samedb-ce.sh

7.5.1

js-upgrade Test

You can run the js-upgrade scripts in test mode using the test option. For example, in Windows enter:
cd <js-install-5.5>/buildomatic js-upgrade-samedb-ce.bat test

In test mode, the js-upgrade scripts check your default_master.properties settings. The application server location is validated and the capability to connect to the specified database is validated. Using test mode can help debug issues, such as an incorrect database password. Your system is not altered when executing the script in test mode.

7.5.2

Output Log Location

The js-upgrade script creates an output log that captures standard output and error output. If there are any problems during the execution of the script or if you want to remember which options you chose, you can open the output log file. The output log file is located here:
<js-install-5.5>/buildomatic/logs/js-upgrade-<date>-<number>.log

7.5.3

Errors

If you encounter errors during the js-upgrade script execution, first look at the output log to see if you can spot any errors. Additionally, you should refer to Appendix A, Troubleshooting, on page 93. The information in this section applies to both js-upgrade scripts and the js-install scripts. If you need to modify values in your default_master.properties file, you can simply edit the file. When the jsupgrade script is run again, the new values will be used.

7.6

Starting and Logging into JasperReports Server 5.5

Start your application server. Your database should already be running.

7.6.1

Clearing Your Browser Cache

Before you log in, make sure you and your end users clear the browser cache. JavaScript files, which enable the UI elements of JasperReports Server, are typically cached by the browser. Clear the cache to ensure that the newer files are used.

58

Upgrading from 5.2 to 5.5

7.6.2
URL:

Logging into JasperReports Server

http://localhost:8080/jasperserver

Log in using the following URL, user IDs, and passwords:

User ID
jasperadmin

Password
<your-password>

Description
Administrator for the default organization

Your JasperReports Server instance has now been upgraded to 5.5. In the event of startup or login problems, refer to Appendix A, Troubleshooting, on page 93

7.7

Additional Tasks to Complete the Upgrade

The tasks described below should be done when the application server is shutdown.

7.7.1

Clearing the Application Server Work Folder

Application servers have work folders where JasperReports Server files are compiled and cached and other objects are stored. When you update the WAR file, the buildomatic deploy-webapp-ce target should automatically clear the application servers work directory, but its a good practice to double-check. A permission problem, or some other problem, could prevent the clearing of the work folder.
To clear the work folder in Tomcat:

1. 2.

Change directory to <tomcat>/work. Delete all the files and folders in this directory.

7.7.2

Clearing the Application Server Temp Folder

JasperReports Server uses caching to speed operations within the application. In the application server, caching files are created and stored for this caching functionality. Typically, these cached files are stored in a temp folder. Clear this temp folder to avoid any conflicts after the upgrade is complete. For Apache Tomcat the temp folder is <tomcat>/temp. (In general, the temp folder used by an Application Server corresponds to the path pointed at by the java.io.tmpdir Java system property.)
To clear the temp folder in Apache Tomcat:

1. 2.

Change directory to <tomcat>/temp Delete all the files and folders in this directory

7.7.3

Clearing the Repository Cache Database Table

In the jasperserver database, compiled JasperReports Library resources are cached in the JIRepositoryCache table for increased efficiency at runtime. In some cases, you may encounter errors running reports after an upgrade. Because the JasperReports Library JAR is typically updated with each new JasperReports Server release, old cached items can get out of date and thus cause errors at runtime. If you encounter errors that mention a JasperReports Library local class incompatible, check your repository cache table. In summary, you can clear your jasperserver database cache table whether there are errors or not as part of this upgrade process.
To manually clear the repository cache database table, run a SQL command similar to one shown below: update JIRepositoryCache set item_reference = null; delete from JIRepositoryCache;

59

JasperReports Server Installation Guide

7.8

Old Manual Upgrade Steps: 5.2 to 5.5

This section has the older, manual upgrade steps that were in place before the js-upgrade shell scripts were implemented in the 4.0 release. These are provided in the following table as a reference, mainly for internal use. The js-upgrade shell scripts execute these buildomatic targets behind the scenes. Jaspersoft recommends using the js-upgrade scripts described in the beginning of this upgrade chapter instead of these manual steps. Older buildomatic upgrade steps for this chapter are the following: Commands
cd <js-install-5.5>/buildomatic js-ant upgrade-5.2-5.5-ce Execute SQL script to upgrade database to 5.5. Executes script buildomatic/install_resources/sql/<dbType>/ upgrade-<dbType>-5.2.0-5.5.0-ce.sql js-ant import-minimal-for-upgrade-ce js-ant import-sample-data-upgrade-ce js-ant deploy-webapp-ce Loads themes and other core resources for 5.5. (Optional) This step is optional. Loads the 5.5 sample data. Delete old 5.2 war file, deploy the 5.5 war file.

Description

60

Upgrading from 3.7 - 5.2 to 5.5

CHAPTER 8

UPGRADING FROM 3.7 - 5.2 TO 5.5

This chapter describes the recommended procedure for upgrading from JasperReports Server 3.7, 3.7.1, 4.0, 4.0.1, 4.1, 4.2, 4.2.1, 4.5, 4.5.1, 4.7, 4.7.1, 5.0 or 5.1 to JasperReports Server 5.5. The upgrade procedures described in this chapter use the JasperReports Server WAR File Distribution ZIP release package and the included buildomatic scripts. The procedure in this chapter can also be used to upgrade JasperReports Server 5.2 to 5.5. However, we recommend you use the procedure in Chapter 7, Upgrading from 5.2 to 5.5, on page 55. In this chapter the examples shown will use JasperReports Server 5.1 as the version being upgraded from. This chapter contains the following sections:

Upgrade Steps Overview Planning Your Upgrade Back Up Your JasperReports Server Instance Exporting Current Repository Data Preparing the JasperReports Server 5.5 WAR File Distribution Configuring Buildomatic for Your Database and Application Server Upgrading to JasperReports Server 5.5 Starting and Logging into JasperReports Server 5.5 Additional Tasks to Complete the Upgrade Old Manual Upgrade Steps

61

JasperReports Server Installation Guide

8.1
1. 2. 3. 4. 5.

Upgrade Steps Overview

These are the general steps used in this section: Plan your upgrade (specifically if upgrading from 4.7 or earlier). Back up your current JasperReports Server instance. Export your existing repository data. For example, export your 5.1 data. Download and set up the new 5.5 JasperReports Server WAR file distribution zip. Run the js-upgrade script as described in section 8.7, Upgrading to JasperReports Server 5.5, on page 65.

If your current instance of JasperReports Server has any custom modifications or extensions, keep track of these and reintegrate them into your 5.5 instance after upgrading.

8.2

Planning Your Upgrade

If you are upgrading from JasperReports Server version 4.7 (or earlier), there is a planning chapter you should review in order to see if there are changes which will affect your deployment. This chapter can be found here: Chapter 9, Planning Your Upgrade from 4.7, on page 69.

8.3

Back Up Your JasperReports Server Instance

First you must backup your JasperReports Server WAR file and jasperserver database so that they can be restored in case there is a problem with the upgrade. These steps are performed from the command line in a Windows or Linux shell. The following backup example is for Tomcat with the PostgreSQL or MySQL database. For other databases, consult your DB administration documentation for back up information.
Back up your JasperReports Server War File:

1. 2.

Create a folder location where you can save your jasperserver war file. For example, C:\JS_52_BACKUP or
opt/JS_52_BACKUP.

Copy <tomcat>/webapps/jasperserver to <path>/JS_52_BACKUP

Back up your Jasperserver Database:

1. 2.

Create a folder location (if you did not do so in the step above) where you can save your jasperserver database, For example, C:\JS_52_BACKUP or /opt/JS_52_BACKUP. Run the following commands for PostgreSQL or MySQL:

PostgreSQL
cd <path>/JS_52_BACKUP pg_dump --username=postgres jasperserver > js-db-5.2-dump.sql

MySQL
cd <path>/JS_52_BACKUP

Windows: mysqldump --user=root --password=<password> jasperserver > js-db-5.2-dump.sql Linux:

mysqldump --user=root --password=<password> --host=127.0.0.1 jasperserver > js-db-5.2-dump.sql For MySQL, If you receive an error about packet size, see section A.8.3, Maximum Packet Size in MySQL, on page 99.

62

Upgrading from 3.7 - 5.2 to 5.5

8.4

Exporting Current Repository Data

You need to export your old repository data, for example your 5.1 repository data, using the JasperReports Server export utility. There are three ways to export:

Use the JasperReports Server UI (since 5.0 release) Use the buildomatic scripts (if you originally installed using buildomatic). Use the js-export-ce.bat/.sh script found in the <js-install>/buildomatic folder.

8.4.1

Using Buildomatic Scripts to Export Data

If you configured buildomatic and your default_master.properties file as described in section 12.3.1, Creating a default_master.properties File, on page 88, you can export your repository data. For example, to export 5.1 repository data, use the following commands: 1. 2. Navigate to the buildomatic directory:
cd <js-install-5.1>/buildomatic

Run buildomatic with the export target: Windows: Linux:

js-ant.bat export-everything-ce -DexportFile=js-5.1-export.zip ./js-ant export-everything-ce -DexportFile=js-5.1-export.zip

Note the location of this export file so that you can use it during the 5.5 upgrade process.

8.4.2

Using the js-export Script to Export Data

To use the js-export-ce.bat/.sh script, navigate to the buildomatic folder, for example, <js-install-5.1>/ buildomatic. If you are using the PostgreSQL database then the js-export script should already be configured to run. If you are using a different database, or you have changed database passwords, you may need to update the js-export configuration. The import-export utility for JasperServer 3.7 needs additional configuration. For complete information on the standard import-export options refer to the JasperReports Server Administrator Guide. Run the following commands: 1. 2. Navigate to the buildomatic directory:
cd <js-install-5.1>/buildomatic

Run the js-export script: Windows: Linux:

js-export-ce.bat --everything --output-zip js-5.1-export.zip js-export-ce.sh --everything --output-zip js-5.1-export.zip

Note the location of this export file so that you can use it during the 5.5 upgrade process.

8.5

Preparing the JasperReports Server 5.5 WAR File Distribution

Use the buildomatic js-upgrade scripts included in the 5.5 WAR file distribution ZIP release package to carry out the upgrade. Follow these steps to obtain and unpack the WAR file distribution ZIP file: 1. 2. The WAR file distribution comes in a file named jasperreports-server-cp-5.5.0-bin.zip in the compressed ZIP format. Download the WAR file distribution from community.jaspersoft.com. Extract all files from jasperreports-server-cp-5.5.0-bin.zip. Choose a destination, such as a C:\Jaspersoft folder on Windows, /home/<user> on Linux, or /Users/<user> on Mac. 63

JasperReports Server Installation Guide After you unpack the WAR File Distribution Zip, the resulting location will be known as:
<js-install-5.5>

8.6

Configuring Buildomatic for Your Database and Application Server

For Unix, the bash shell is required for the js-upgrade scripts. If you are installing to a non-Linux Unix platform such as HP-UX, IBM AIX, FreeBSD or Solaris, you need to download and install the bash shell. See Bash Shell for Solaris, IBM AIX, HP UX and FreeBSD on page 95 for more information.

This upgrade procedure uses the js-upgrade-newdb-ce shell script.

This section shows example configurations for the PostgreSQL and MySQL databases.

8.6.1

Example Buildomatic Configuration

The upgrade configuration is handled by the default_master.properties file. Jaspersoft provides a sample configuration file for each database. You must specify your database credentials and your application server location, and rename the file to default_master.properties. 8.6.1.1 1. PostgreSQL Example

This example shows how to configure default_master.properties for PostgreSQL. Locate the postgresql_master.properties sample configuration file: Database
PostgreSQL

Master Properties File

<js-install-5.5>/buildomatic/sample_conf/postgresql_master.properties

2. 3. 4.

Copy the file to <js-install-5.5>/buildomatic Rename the file default_master.properties Edit default_master.properties for your database and application server: Database
PostgreSQL

Sample Property Values

appServerType=tomcat6 [tomcat7, tomcat5, jboss, glassfish2, glassfish3] appServerDir=c:\\Apache Software Foundation\\Tomcat 6 dbUsername=postgres dbPassword=postgres dbHost=localhost

8.6.1.2 1.

MySQL Example

This example shows how to configure default_master.properties for MySQL. Locate the mysql_master.properties sample configuration file: Database
MySQL

Master Properties File

<js-install-5.5>/buildomatic/sample_conf/mysql_master.properties

2. 3.

Copy the file to <js-install-5.5>/buildomatic Rename the file default_master.properties

64

Upgrading from 3.7 - 5.2 to 5.5 4. Edit default_master.properties for your database and application server: Database
MySQL

Sample Property Values

appServerType=tomcat6 [tomcat7, tomcat5, jboss, glassfish2, glassfish3] appServerDir=C:\\Apache Software Foundation\\Tomcat 6 dbUsername=root dbPassword=password dbHost=localhost

8.7

Upgrading to JasperReports Server 5.5

Make sure you have backed up your jasperserver database before proceeding. Make sure you have backed up your old JasperReports Server WAR file before proceeding.

Now that your buildomatic scripts have been configured, you can complete the upgrade.

1. 2. 3.

Stop your application server Start your database server Run the following commands: Commands
cd <js-install-5.5>/buildomatic js-upgrade-newdb-ce.bat <path>\js-5.1export.zip

Description
Change to buildomatic directory (Windows) Upgrade jasperserver war file, drop and recreate the database, import data file from previous version. (Linux) Upgrade jasperserver war file, drop and recreate the database, import data file from previous version.

./js-upgrade-newdb-ce.sh <path>/js-5.1export.zip

On MySQL, if you receive an error about packet size, see section A.8.3, Maximum Packet Size in MySQL, on page 99.

If you have auditing enabled, see section A.11.1, Include Audit Events on Upgrade, on page 110 for information on including auditing events.

8.7.1

js-upgrade Test Mode

You can run the js-upgrade script in test mode using the test option. For example, on Window, enter:
cd <js-install-5.5>/buildomatic js-upgrade-newdb-ce.bat test <path>/js-5.1-export.zip

In test mode, the js-upgrade scripts check your default_master.properties settings. The application server location and the capability to connect to the specified database are validated. Using test mode can help debug issues such as an incorrect database password. Your system will not be altered when executing the script in test mode.

8.7.2

Output Log Location

The js-upgrade script creates an output log that captures standard output and error output. If there are any problems during the execution of the script, or if you want to remember which options you chose, you can open the output log file. The output log file is located here: 65

JasperReports Server Installation Guide

<js-install-5.5>/buildomatic/logs/js-upgrade-<date>-<number>.log

8.7.3

Errors

If you encounter errors during the js-upgrade script execution, first look at the output log to see if you can spot any errors. Also, refer to the Troubleshooting section Appendix A, Troubleshooting, on page 93. The information in this section applies to js-upgrade scripts as well as js-install scripts. If you need to modify values in your default_master.properties file, you can simply edit the file. When you run the js-upgrade script again, the new values are used.

8.8

Starting and Logging into JasperReports Server 5.5

Start your application server. Your database should already be running.

8.8.1

Clearing Your Browser Cache

Before you log in, make sure you and your end users clear the browser cache. JavaScript files, which enable the UI elements of JasperReports Server, are typically cached by the browser. Clear the cache to ensure that the newer files are used.

8.8.2
URL:

Logging into JasperReports Server

http://localhost:8080/jasperserver

Log in using the following URL, user IDs, and passwords:

User ID
jasperadmin

Password
<your-password>

Description
Administrator for the default organization

Your JasperReports Server instance has now been upgraded to 5.5. In the event of startup or login problems, refer to Appendix A, Troubleshooting, on page 93.

8.9

Additional Tasks to Complete the Upgrade

The tasks described below should be done when the application server is shutdown.

8.9.1

Handling JasperReports Server Customizations

If you made modifications or customizations to the original JasperReports Server application, JasperReports Server 5.1 for example, these configurations are typically found in the WEB-INF/applicationContext-*.xml set of files. Configuration modifications, such as client-specific security classes or LDAP server configurations, need to be hand-copied from your previous environment and re-integrated into the upgraded environment.

8.9.2

Clearing the Application Server Work Folder

Application servers have work folders where JasperReports Server files are compiled and cached and other objects are stored. When you update the WAR file, the buildomatic deploy-webapp-ce target should automatically clear the application servers work directory, but its a good practice to double-check. A permission problem, or some other problem, could prevent the clearing of the work folder.
To clear the work folder in Tomcat:

1.

Change directory to <tomcat>/work.

66

Upgrading from 3.7 - 5.2 to 5.5 2. Delete all the files and folders in this directory.

8.9.3

Clearing the Application Server Temp Folder

JasperReports Server uses caching to speed operations within the application. Caching files are created and stored in the application server to support this functionality. Typically, these cached files are stored in a temp folder. Clear this temp folder to avoid any conflicts after the upgrade is complete. Typically, the temp folder used by an application server corresponds to the path pointed at by the java.io.tmpdir Java system property. For Apache Tomcat the temp folder is <tomcat>/temp.
To clear the temp folder in Apache Tomcat:

1. 2.

Change directory to <tomcat>/temp Delete all the files and folders in this directory

8.9.4

Clearing the Repository Cache Database Table

In the jasperserver database, compiled JasperReports Library resources are cached in the JIRepositoryCache table for increased efficiency at runtime. In some cases, you may encounter errors running reports after an upgrade. Because the JasperReports Library JAR is typically updated with each new JasperReports Server release, old cached items can get out of date and thus cause errors at runtime. If you encounter errors that mention a JasperReports Library local class incompatible, check your repository cache table.You can clear your jasperserver database cache table whether there are errors or not as part of this upgrade process.
To manually clear the repository cache database table, run a SQL command similar to one shown below: update JIRepositoryCache set item_reference = null; delete from JIRepositoryCache;

8.10

Old Manual Upgrade Steps

This section has the older, manual upgrade steps that were in place before the js-upgrade shell scripts were implemented in the 4.0 release. These are provided in the following table as a reference, mainly for internal use. The js-upgrade shell scripts execute these buildomatic targets behind the scenes. Jaspersoft recommends using the js-upgrade scripts described in the beginning of this upgrade chapter instead of these manual steps. Older buildomatic upgrade steps for this chapter are the following (using a 5.1 upgrade as an example): Commands
cd <js-install-5.5>/buildomatic js-ant drop-js-db js-ant create-js-db js-ant init-js-db-ce js-ant import-minimal-ce js-ant import-upgrade -DimportFile=<path-and-filename> The -DimportFile should point to the <path> and <filename> of the js-5.1-export.zip file you created earlier. On Windows, you must use double quotation marks () if your path or filename contains spaces. On Linux, you must use double quotation marks, escaped with a backslash (\) in this case. This will delete and recreate your jasperserver db. Make sure your original database is backed up.

Description

67

JasperReports Server Installation Guide Commands

js-ant import-sample-data-upgrade-ce

Description
(Optional) This step is optional; it loads the new sample data. The old sample data is overwritten, so you may need to redo certain changes such as configuring the sample data sources for your database. Delete the existing older war file, deploy the new war file.

js-ant deploy-webapp-ce

68

Planning Your Upgrade from 4.7

CHAPTER 9

PLANNING YOUR UPGRADE FROM 4.7

If you are upgrading from JasperReports Server 4.7 or earlier you should take a look at the information included in this chapter. Some of the new and enhanced features in JasperReports Server 4.7 and 5.0 can significantly affect your deployment and you should plan your upgrade accordingly. Prior to upgrading to you should make sure to:

Review this chapter carefully and determine how the changes described affect your deployment. Make sure to back up your current JasperReports Server installation and repository before upgrading.

This chapter describes only those changes that can significantly impact your existing deployment.
These upgrade steps are for the WAR installation.

For an overview of new features, improvements, and bug fixes see the release notes in the root directory of the distribution. For information on how to use the new features, see the JasperReports Server User Guide or the JasperReports Server Administrator Guide. This chapter contains the following sections:

Understanding the Changes in 4.7 Migrating Ad Hoc Reports to Ad Hoc Views Upgrading Themes in 4.7 Data Snapshots Understanding the Changes in 5.0 Upgrading Preserving Custom Settings If you perform an upgrade using the WAR file scripts, there is no specific action you need to take. However, you need to be aware that the js-upgrade-samedb-ce script will automatically preserve any custom global properties you have set, whereas the js-upgrade-newdb-ce script will not preserve your custom global properties.

9.1

Understanding the Changes in 4.7

The following changes in 4.7 can significantly affect your deployment: Themes: An upgraded user interface eliminates unnecessary white space and lets users see more on a single screen. There have been changes to the resources and CSS used by themes, which make it easier to build and maintain new themes.

69

JasperReports Server Installation Guide However, existing themes will have to be redesigned in order to work in 5.0. SeeUpgrading Themes in 4.7 on page 70 for details on how to upgrade themes. Data Snapshots: Reports stored in JasperReports Server can now be configured to store snapshots of the report data in the repository resource. Data snapshots load quickly without querying the data source, thus increasing performance and reducing database load. If data snapshots are turned on, size requirements for your repository may increase dramatically. Data snapshots are disabled globally by default. See Migrating Ad Hoc Reports to Ad Hoc Views on page 70 for more information on data snapshots.

9.2

Migrating Ad Hoc Reports to Ad Hoc Views

The workflow ofeports. You can locate problematic reports in the repository using a simple search.

9.2.1

Changes to Ad Hoc

Table 9-1 summarizes the differences between Ad Hoc reports and Ad Hoc views.

9.2.2

Output of Migration Process

When you upgrade, eaocation and month

9.3

Upgrading Themes in 4.7

The look and feel of the JasperReports Server web interface has been redesigned to increase usable space and be more compatible across browsers. In addition, navigation has been improved with simplified menus and a new Library page that provides quick access to all reports, dashboards, and views a user may access. To accomplish this, images, markup, and styles have been modified and many elements and images are smaller in size. As a result of these modifications, custom themes developed for the previous interface will need to be updated for the new interface. This section details the changes made to the user interface and describes some of the steps necessary to update custom themes. For information on developing new themes, see the JasperReports Server Administrator Guide.

9.3.1

Banner and Toolbar Modifications

Banner settings have changed in 4.7, which means you will need to modify your theme to work with the new banner. Table 9-1 shows the elements you need to modify and their default locations. The default values are for these elements are in the default.css file. Table 9-1 Element
Banner

Banner and Toolbar Settings Classname and Modification

.banner Give custom value to height.

File
containers.css

Notes
Default value: height:26px Default values: height: 20px width: 115px

Banner Logo

#logo Give custom values to height and width that match the dimensions of your logo.

theme.css

Banner Main Navigation

.menu.primaryNav .wrap Set height and line-height to the same measurement as .banner.

containers.css

Default values: height: 26px line-height: 26px

70

Planning Your Upgrade from 4.7 Table 9-1 Element

Banner Main Navigation

Banner and Toolbar Settings Classname and Modification

.menu.primaryNav .wrap.over .menu.primaryNav .wrap.pressed If you already have values for these defined in your alternate theme, then you need to change height and line-height to match the height of .banner.

File
containers.css

Notes
Not explicitly defined, but a value of 26px for both elements is cascaded from .menu.primaryNav .wrap If the over and pressed effects fill the banner height after applying the modifications to .menu.primaryNav .wrap, then this step is not necessary. Default value: background-position: left -166px. Height should be two pixels shorter than banner height. Height is not explicitly defined, but a value of 24px is cascaded from .button .icon in buttons.css Width is not explicitly defined, but a value of 14px is cascaded from .menu.primaryNav #main_ home .wrap > .icon in the containers.css file.

Banner Main Navigation Home icon

.menu.primaryNav #main_home .wrap > .icon Set height to be 2px shorter than the height of .banner. Set values for width and background-position to fit your image.

containers.css

Banner Main Navigation Item arrow icon

.menu.primaryNav .node > .wrap > .icon Set height to your desired value, with the maximum value being the same height measurement as the .banner element. Set background-position to a value that properly displays the default or your custom image. .menu.primaryNav .wrap.over .menu.primaryNav .wrap.pressed Set background-position to a value that properly displays the default or your custom image.

containers.css

Default values: height: 30px; background-position: 0 -78px background-position: 0 -78px (IE8-9) background-position: 0 -79px (Ch+Saf) If you are using Chrome or Safari, the classname that you apply background position to must be preceded by "body:nth-of-type(1)".

Banner Main Navigation Item arrow icon

containers.css

background-position is not explicitly defined. The value is cascaded from .menu.primaryNav .node > .wrap > .icon This only needs to be adjusted if you want a different color disclosure indicator for the pressed and over states of the main menu links.

Banner Metadata

#metalinks li Set line-height to the desired value that will vertically center it within the banner. #globalSearch.searchLockup Set margin-top to desired value that will vertically center it within the banner. #frame Set a custom top value that positions the body of the application below the banner.

theme.css

Default value: line-height: 9px

Banner Search container Body

controls.css

Default value: margin-top:3px

containers.css

Default value: top: 28px This value needs to be greater than the value you apply to the height of .banner.

71

JasperReports Server Installation Guide Table 9-1 Element

Toolbar

Banner and Toolbar Settings Classname and Modification

.toolbar Set custom height value that will fit your capsule buttons.

File
containers.css

Notes
Default value: height: 28px This is only necessary if you have customized capsule buttons that differ in height from the default images.

Footer

#frameFooter Rename ID in stylesheet

containers.css

The #footer element was renamed to #frameFooter. Change style rules for #footer to #frameFooter.

9.3.2

Changes to IE Overrides

All style rules have been moved out of the IE-specific CSS files and into the base CSS files. IE-specific notations have been applied to these rules so they can be condensed into the class declarations with the other style rules for a given element. IEspecific styles are commented as shown below:

The following comment indicates a general IE style rule: \* IE \* The following comment indicates a style rule specific to IE7: \* IE7 \* The following comment indicates a style rule specific to IE8 and IE9: \* IE8 and IE9 \*

Table 9-2 shows an example of an IE7 style rule that has been combined into the base style rules in 5.0 and newer. : Table 9-2 Changes to Implementation for IE Style Rules lists.css (4.5.1 and earlier)
.stepIndicator .icon { margin: 0; top: 1px; margin-right: 3px; }

IE overrides (4.5.1 and earlier)

.stepIndicator .icon { *top: 2px; }

lists.css (4.7)
.stepIndicator .icon { position: relative; margin: 0px; top: 1px; *top: 2px; \\* IE7 \\ margin-right: 3px; }

9.3.3

Images in JasperReports Server 4.7

Images for navigation, buttons, and backgrounds in the default theme have changed in version 5.0 and newer. Some images have been deleted or moved into a sprite file with a different name, other images have been modified and their properties (such as height and width) may have changed. You need to ensure your custom themes refer to these images. If you have used custom images, you may need to adjust them to work with the new default scheme. This section lists the image files and indicates the changes. Table 9-3 lists the images that have been added in the 4.7 default theme.

72

Planning Your Upgrade from 4.7 Table 9-3 Image

banner_bkgd.png column_header_bkgd.png

New Images in 4.7 Default Theme Usage

Background gradient image for application banner Background gradient image for .header elements in columns and dialogs Pagination icons (next, previous, etc) for dashboard report widgets Icon that appears in the column header of spacer columns in Ad Hoc Editor Button icons for the Ad Hoc Editor toolbar Replaces panel_dialog_header_sprite.png image used for dialog box headers in 4.5.1.

Notes

inner_pagination_sprite.png spacer.gif viewer_toolbar_buttons_sprite.png

Table 9-4 lists the images that have been modified for the 5.0 and newer default theme. Table 9-4 Image
adhoc_toolbar_buttons_sprite.png button_action_primary_sprite.png

Modified Images in 4.7 Default Theme Usage

Button icons for the Ad Hoc Editor toolbar Background gradient images for the three states of .action.primary buttons Background gradient image for the up, over, and pressed states of action buttons Button icons for the .action.square buttons Background images with rounded corners for capsule buttons Background images for the up, over, and pressed states of options buttons Small icons that disclose functionality in various parts of the application (within buttons, menus, lists, and forms) Large background image on home page Large icons for .action.jumbo button on home and admin home pages Top inner shadow background image for text inputs Main image on login page of pro edition Main image on login page of community edition

Notes
Some icons are new. All icons have new shadow effect. Removed rounded corners. Colors were adjusted. Removed rounded corners. Colors were adjusted. All icons have new shadow effect. Rounded corners have a smaller radius. Colors adjusted. Buttons are shorter in height. Removed rounded corners. Added a shadow-only image for the pressed state. Shadow effect added to icons for .button.capsule.indicator . Image refactored. Icons for View Reports and Create Ad Hoc View refactored. Shadow lightened. Image height changed from 2px tall to 3px tall. Image refactored. Image refactored.

button_action_sprite.png

button_action_square_icons_sprite.png button_capsule_sprite.png

button_options_sprite.png

disclosure_indicators_sprite.png

home_bkgd.png home_icons_sprite.png input_bkgd.png login_welcome_bkgd.jpg login_welcome_ce_bkgd.jpg

73

JasperReports Server Installation Guide Table 9-4 Image

logo.png menu_primaryNav_sprite.png

Modified Images in 4.7 Default Theme Usage

Logo used in the banner of the application Sprite containing background gradients for mouse over effects and the home icon used in the main menu

Notes
Image is smaller. Home icons reduced in size and shadow effect added.

panel_inset_inset_bkgd.png search_sprite.png tabs_horizontal_sprite.png Icons used in search controls (search and clear search) Background gradient images for the over and pressed states of horizontal tabs Background gradient images for the up, over and pressed states of vertical tabs Images refactored. Input background removed. Removed rounded corners. Colors adjusted. Removed rounded corners. Colors adjusted.

tabs_vertical_sprite.png

Table 9-5 lists the images that have not been affected by the refactoring of themes in 5.0 and newer. Table 9-5 Image
adhoc_datatree_icons_sprite.png floatingMenu_sprite.png grid_20x20_bkgd.png list_node_animation.gif list_pressed_bkgd.png lists_sprite.png loadinfo.gif message_icons_sprite.png panel_sizer_sprite.png report_load_animation.gif sort_indicators_sprite.png tabs_horizontal_buttons_bkgd.png wait_animation_large.gif

Images With No Modifications in 4.7 Usage

Node and leaf images for fields, measures, and dimensions in the ad hoc data tree Popup menu icons for dashboard widgets Grid background for dashboard designer canvas Miniature please wait animation used in list nodes Background image for the top inner shadow that appears for the pressed state of a .list.filter list item Small icons used in various lists throughout the application. Also used for tokens, menus and OLAP cell sorting Please wait animation used for iPad only Sprite containing a single icon used for alert message Sprite containing icons for resizing panels and dialogs Animation used in the toolbar of the interactive viewer when a report is loading Sprite containing icons used for the up, over, and pressed states of sortable lists (ascending and descending) Image used as the top drop shadow for .tabSet.horizontal.buttons Please wait animation used in dialog boxes on page loads and in dashboard iframes when widgets are loading

Table 9-6 shows images used in the earlier themes that have been removed in 5.0, as well as images that have been refactored by placing them in the file inner_pagination_sprite.png.

74

Planning Your Upgrade from 4.7 Table 9-6 Image

ajax-loader.gif

Images from Previous Default Theme Removed in 4.7 Usage

Animation used in the please wait dialog for printing dashboards that contain charts Gradient background image used as the body background for all pages Background images with rounded corners used for up, over, and pressed states of jumbo buttons Background image used for rounded corners with drop shadow on column decorated elements Background image used for right and left borders with drop shadow on column decorated elements Background image used for top and bottom borders with drop shadow on column decorated elements Disabled state of go to first icon used for pagination controls inside report dashboard widgets Go to first icon used for pagination controls inside report dashboard widgets Gradient background image for the #frame element Background image used for rounded corners with drop shadow on the #frame element Drop shadow image used for right and left edges of the #frame element Drop shadow image used for top and bottom edges of the #frame element Gradient background image with rounded corners used for the header of the #frame element. Disabled state of go to last icon used for pagination controls inside report dashboard widgets Go to last icon used for pagination controls inside report dashboard widgets Main image on login page for iPad Logo used in the frame header/main navigation bar for iPad #frame header element holds the main navigation. Image moved to sprite file inner_pagination_sprite.png. Image placed in sprite file inner_pagination_sprite.png. Image placed in sprite file inner_pagination_sprite.png Image placed in sprite file inner_pagination_sprite.png

Notes
replaced with wait_animation_large.gif

body_bkgnd.png button_action_jumbo_sprite.png

column_bkgd_corners.png

column_bkgd_edges_rl.png

column_bkgd_edges_tb.png

first-d.gif

first.gif

frame_background_sprite.png frame_bkgd_corners.png

frame_bkgd_edges_rl.png frame_bkgd_edges_tb.png frame_header_sprite.png

last-d.gif

last.gif

login_welcome_bkgd_ipad.jpg logo_small.png

75

JasperReports Server Installation Guide Table 9-6 Image

menu_context_bkgd_corners.png

Images from Previous Default Theme Removed in 4.7 Usage

Background image used for rounded corners with drop shadow on .menu.context elements Background image used for right and left borders with drop shadow on .menu.context elements Background image used for top and bottom borders with drop shadow on .menu.context elements Background image used for rounded corners with drop shadow on .menu.dropDown elements Background image used for right and left borders with drop shadow on .menu.dropDown elements Background image used for top and bottom borders with drop shadow on .menu.dropDown elements Background for .menu.vertical Disabled state of next icon used for pagination controls inside report dashboard widgets Next icon used for pagination controls inside report dashboard widgets Background image of rounded corners with drop shadow used for the .dialog.overlay element Background image of right and left borders with drop shadow used for the .dialog.overlay element Background image of top and bottom borders with drop shadow used for the .dialog.overlay element Background for dialog headers Background image of rounded corners with drop shadow used for the .info element Background image of right and left borders with drop shadow used for the .info element Background image of top and bottom borders with drop shadow used for the .info element Background image of rounded corners used for the .info.system element Image placed in sprite file inner_pagination_sprite.png. Image placed in sprite file inner_pagination_sprite.png.

Notes

menu_context_bkgd_edges_rl.png

menu_context_bkgd_edges_tb.png

menu_dropDown_bkgd_corners.png

menu_dropDown_bkgd_edges_rl.png

menu_dropDown_bkgd_edges_tb.png

menu_vertical_bkgd.png next-d.gif

next.gif panel_bkgd_corners.png

panel_bkgd_edges_rl.png

panel_bkgd_edges_tb.png

panel_dialog_header_sprite.png panel_info_bkgd_corners.png

panel_info_bkgd_edges_rl.png

panel_info_bkgd_edges_tb.png

panel_info_system_bkgd_corners.png

76

Planning Your Upgrade from 4.7 Table 9-6 Image

panel_info_system_bkgd_edges_rl.png

Images from Previous Default Theme Removed in 4.7 Usage

Background image of right and left borders used for the .info.system element Background image of top and bottom borders used for the .info.system element Background image of rounded corners used for the .panel.tooltip.info element Background image of right and left borders used for the .panel.tooltip.info element Background image of top and bottom borders used for the .panel.tooltip.info element Background image of rounded corners with drop shadow used for the .dialog.inlay element Background image of left and right borders with drop shadow used for the .dialog.inlay element Background image of top and bottom borders with drop shadow used for the .dialog.inlay element Left background image with gradient and rounded corners used for the .dialog.inlay .footer element Right background image with gradient and rounded corners used for the .dialog.inlay .footer element Background image of rounded corners with drop shadow used for the .groupBox element Background image of left and right borders with drop shadow used for the .groupBox element Background image of top and bottom borders with drop shadow used for the .groupBox element Background gradient with rounded corners used for the headers of the .panel.widget and .dialog.overlay.widget elements Disabled state of Previous icon used for pagination controls inside report dashboard widgets Image placed in sprite file inner_pagination_sprite.png

Notes

panel_info_system_bkgd_edges_tb.png

panel_info_tooltip_bkgd_corners.png

panel_info_tooltip_bkgd_edges_rl.png

panel_info_tooltip_bkgd_edges_tb.png

panel_inlay_bkgd_corners.png

panel_inlay_bkgd_edges_rl.png

panel_inlay_bkgd_edges_tb.png

panel_inlay_gradient_left.png

panel_inlay_gradient_right.png

panel_inset_bkgd_corners.png

panel_inset_bkgd_edges_rl.png

panel_inset_bkgd_edges_tb.png

panel_widget_header_sprite.png

prev-d.gif

77

JasperReports Server Installation Guide Table 9-6 Image

prev.gif

Images from Previous Default Theme Removed in 4.7 Usage

Previous icon used for pagination controls inside report dashboard widgets Background gradient image for the .toolbar element

Notes
Image placed in sprite file inner_pagination_sprite.png

toolbar_bkgd.png

9.4

Data Snapshots

As of 5.0, reports in JasperReports Server can store snapshots of the report data as part of the report unit in the repository. Data snapshots load quickly without querying the data source, thus increasing performance and reducing database load. Data snapshots can be refreshed on-demand, by scheduling, or by setting server-wide or report-specific policies. Existing installations should also resolve any upgrade issues before enabling data snapshots. Data snapshots are stored in the JasperReports Server repository, which may significantly increase the size of the repository. Before enabling data snapshots, you may want to analyze the effect of snapshots on your repository size and upgrade your storage. For most installations, the benefits from reducing the overall number of queries should outweigh the cost of additional storage. The actual effect on your repository size depends on the nature of your reports and how many snapshots you enable. It is difficult to give a standard estimate, because snapshot size depends on factors such as the number of columns and the complexity of the report. For a given report, the overall snapshot size is usually proportional to the number of rows. For example, if you have a report of 100,000 records, with 20 records per page, and the snapshot size for one page is 2KB, the overall size of the snapshot will be (100,000 20) 2 KB, or 10 MB. Data snapshots are turned off globally by default in 5.0 and newer. If you enable data snapshots, they can be turned on or off for each individual report. See the JasperReports Server Administrator Guide for more information about enabling data snapshots in your JasperReports Server deployment. See the JasperReports Server User Guide for more information about using data snapshots with individual reports.

9.4.1

Using Data Snapshots

Enabling data snapshots has the following benefits: Queries are only run when a new data snapshot is enabled, when the snapshot is refreshed, and automatically when the server detects that the snapshot is out of date. This allows multiple users to look at the same report without running multiple queries. Sharing data snapshots means everyone sees identical data. A data snapshot is a static entity that reflects the state of the data at the time the snapshot was created. This eliminates differences sometimes experienced when data has changed in the repository, or queries are run in different time zones. Users can refresh a snapshot and view the latest data by clicking a Refresh button. Non-administrative users do not have permissions to overwrite the snapshot after refresh. You can turn off snapshots for reports that need to be dynamic, such as real-time reports in dashboards.

9.5

Understanding the Changes in 5.0

The following changes in 5.0 and newer can significantly affect your deployment: Upgrading preserving global properties: If you perform an upgrade using the WAR file scripts, you might be able to preserve any custom global settings you have set. See 9.6, Upgrading Preserving Custom Settings, on page 79 for more information about this feature.

78

Planning Your Upgrade from 4.7

9.6

Upgrading Preserving Custom Settings

If you perform an upgrade using the WAR file scripts, there is no specific action you need to take. However, you need to be aware that the js-upgrade-samedb-ce script will automatically preserve any custom global properties you have set, whereas the js-upgrade-newdb-ce script will not preserve your custom global properties.

79

JasperReports Server Installation Guide

80

Upgrading JasperServer 3.5 or Earlier

CHAPTER 10 UPGRADING JASPERSERVER 3.5 OR EARLIER

10.1
1. 2.

Upgrading from 3.5 or Earlier

If you are running JasperServer version 3.5, you must upgrade in two steps: Upgrade from version 3.5 to version 3.7. Upgrade from version 3.7 to version 5.5.

The steps to perform this upgrade are documented in the JasperServer Installation Guide for the 3.7 release. Download the JasperServer 3.7 WAR file distribution zip package to get the relevant files and documentation. The Installation Guide is in the docs folder. Download the JasperServer 3.7 WAR file distribution zip package from http://community.jaspersoft.com. If you are running a JasperServer version earlier than 3.5, first upgrade to 3.7, then to 5.5.

10.2
1.

Best Practices for Upgrading under Windows

There are two standard procedures for installing JasperReports Server. The two installation methods are the following: Installing with the Binary Installer and Bundled Components The binary installer is an executable which can put all of the components in place to run JasperReports Server. So, for instance, if you take the default choices during the installation, you will get the Apache Tomcat application server, the PostgreSQL database and Java execution environment. However, it should be kept in mind that these components are specially configured to run JasperReports Server. These components are also hard coded so that they apply to a specific version of JasperReports Server. This is true with the Windows Start Menu items created to start and stop JasperReports Server. 2. Installing to Pre-existing Components When installing a Production type instance of JasperReports Server, it is common to pre-install the main components before installing JasperReports Server. This is because the System Administrator will have more control over updating and upgrading these components such as Apache Tomcat (or any other certified application server), PostgreSQL (or any other certified database) and Java. Once the Administrator puts these pre-existing components in place, there are two ways to install JasperReports Server: a. Using the War File ZIP distribution (file name: jasperreports-server-cp-<ver>-bin.zip)

81

JasperReports Server Installation Guide JasperReports Server will be installed to the existing components using the js-install.bat scripts. The Administrator will create a default_master.properties file that will specify where to find the application server and database components. b. Using the Binary Installer (file name: jasperreports-server-cp-<ver>-windows-<x86/64>-installer.exe) The installer will prompt the Administrator to specify where to find the application server and database components. If you are installing JasperReports Server under the Windows operating system and you intend to have this be a long running instance that will be upgraded with future releases then it is recommended that you install to pre-existing components. This will reduce any confusion that might be caused after an upgrade is completed by having Windows Start Menu items that show an older version (i.e. the originally installed version number) of JasperReports Server.

82

Password Encryption in JasperReports Server

CHAPTER 11 PASSWORD ENCRYPTION IN JASPERREPORTS SERVER

By default, password encryption is enabled in JasperReports Server and passwords are stored as cipher text in the database. System administrators can change the encryption algorithm and specify the salt key used to initiate the encryption algorithm. This chapter describes the procedure to enable password encryption if you have a JasperReports Server instance without encryption turned on. For more information about encryption options, see the JasperReports Server Administrator Guide. This chapter contains the following sections:

Backing Up Your JasperReports Server Database Stopping Your Application Server Running the Repository Export Utility Specifying Encryption Settings in the JasperReports Server WAR Specifying Encryption Settings for the Import Utility Recreating the JasperReports Server Database Importing Your Repository Data Starting the Application Server Logging into JasperReports Server

11.1

Backing Up Your JasperReports Server Database

As a precaution, you must back up your jasperserver database in the event of a problem while enabling encryption. To back up the default PostgreSQL database, go to the <js-install> directory and run the following command:
pg_dump -U postgres jasperserver > js-backup.sql

11.2

Stopping Your Application Server

You can now stop your application server. You should leave your database running.

83

JasperReports Server Installation Guide

11.3

Running the Repository Export Utility

The repository export utility writes the JasperReports Server repository objects to a set of XML and binary files. The output of the export operation is known as an export catalog. To create the export catalog, go to the <js-install>/buildomatic directory and run the following commands. Note that there are two dashes (--) in front of the command options: Windows: js-export-ce.bat --everything --output-dir js-backup-catalog Linux:
js-export-ce.sh --everything --output-dir js-backup-catalog

For information about running the export utility, refer to Chapter 12, Configuring the Import-Export Utilities, on page 87. You may also run the export operation from the JasperReports Server UI. Refer to Running Import or Export from the UI on page 90 for information on running export from the UI.

11.4

Specifying Encryption Settings in the JasperReports Server WAR

JasperReports Server uses the Spring configuration and security to enable and configure encryption. Use these options to set up strong encryption. This section is focused on the minimal configuration for enabling encryption. 1. 2. Open the following file for editing: <tomcat/webapps/jasperserver/WEB-INF/ApplicationContext-security.xml In the definition of the daoAuthenticationProvider bean, there is a commented-out reference to the passwordEncoder bean. Look for the section of the XML file that starts with:
<bean id=daoAuthenticationProvider

3.

Enable encryption in the passwordEncoder bean by modifying the allowEncoding property. Change the value from false to true so that it looks like this:
<property name=allowEncoding><value>true</value></property>

4.

If the default DESede algorithm is used, the secretKey represents the salt key and must be 24 characters. By default, the keyInPlainText property is true, meaning the key can be in plain text to make it easier to enter, for example:
<property name=keyInPlainText><value>true</value></property> <property name=secretKey><value>jaspersoftInSanFrancisco</value></property> The text jaspersoftInSanFrancisco is 24 characters long, therefore the two properties above work with their default values. However, for better security, we recommend that they be changed.

5.

The last two properties may be left unchanged. They are set to DESede by default. The default values are the following:
<property name=secretKeyAlgorithm><value>DESede</value></property> <property name=cipherTransformation><value>DESede/CBC/PKCS5Padding</value></property> The secretKey, secretKeyAlgorithm, and cipherTransformation property settings must be consistent with each other. For example, different algorithms expect different key lengths.

6.

Save and close the file. Encryption is now enabled for the JasperReports Server application upon the next restart.

11.4.1

Specifying Encryption Settings - Reference Table

The information in the Table 11-1 is a summary of the available password encryption configuration options described in the previous section. Table 11-1 Password Encryption Configuration Options

Configuration File
\WEB-INF\applicationContext-security.xml

84

Password Encryption in JasperReports Server Table 11-1 Property

passwordEncoder

Password Encryption Configuration Options, continued Bean

daoAuthentication Provider passwordEncoder

Description
Comment this property out to disable the encryption of passwords. The salt key to use as a pass phrase when encrypting passwords. This string is used to encrypt passwords. This value can be a simple string or a numeric representation that can be parsed by Integer.decode(). For example: String: This is my secret key Numeric representation: 0xC8,0x43,0x29,0x49,0xAE,0x25,0x2F,0xA1,0xC1

secretKey

keyInPlainText

passwordEncoder

Determines whether the secret key is a simple string or a numeric representation. Set this parameter to TRUE if the secretKey is a string; set it to FALSE if the key is a numeric representation. The name of the algorithm to use, such as DESede. The name of the transformation, such as DES/CBC/ PKCS5Padding.

secretKeyAlgorithm cipherTransformation

passwordEncoder passwordEncoder

The secretKey, secretKeyAlgorithm, and cipherTransformation must be consistent with each other. For example, if the secretKeyAlgorithm is DESede, the secretKey must be 24 bytes long. For more information about secretKey, secretKeyAlgorithm, and cipherTransformation, see Suns javax.crypto documentation.

11.5

Specifying Encryption Settings for the Import Utility

To continue with the process of changing your encryption settings, you should add the same encryption settings to the importexport functionality as you did for the JasperReports Server WAR in the sections above. 1. 2. Open the following configuration file for editing:
<js-install>/buildomatic/conf_source/iePro/applicationContext-security.xml

This file contains the passwordEncoder bean definition, the same as in the JasperReports Server WAR, only by itself. Modify this file to specify the encryption settings as described in section 11.4, Specifying Encryption Settings in the JasperReports Server WAR, on page 84.

11.6

Recreating the JasperReports Server Database

Next, drop your existing jasperserver database and recreate an empty jasperserver database.

11.6.1
1. 2.

Dropping and Recreating the Database in PostgreSQL

Change directory to <js-install>/buildomatic/install_resources/sql/postgresql. Start psql using an administrator account such as postgres:
psql -U postgres

85

JasperReports Server Installation Guide 3. Drop the jasperserver database, create a new one, and load the jasperserver schema:
drop database jasperserver; create database jasperserver encoding='utf8'; \c jasperserver \i js-create.ddl \i quartz.ddl

11.6.2
1. 2. 3.

Dropping and Recreating the Database in MySQL

Change directory to <js-install>/buildomatic/install_resources/sql/mysql. Log into your MySQL client:

mysql -u root -p

Drop the jasperserver database, create a new one, and load the jasperserver schema:

11.6.3
mysql>drop database jasperserver; mysql>create database jasperserver character set utf8; mysql>use jasperserver; mysql>source js-create.ddl; mysql>source quartz.ddl;

11.7

Starting the Application Server

You can now start your application server. Your database should already be running.

11.8

Logging into JasperReports Server

You can now log into JasperReports Server. Enter your user ID and password in the same manner as you did before encryption was turned on. You can check the contents of the JIUser table in the jasperserver database and examine the password column to see that the password is no longer stored in plain text.

86

Configuring the Import-Export Utilities

CHAPTER 12 CONFIGURING THE IMPORT-EXPORT UTILITIES

The import and export utilities add resources to or extract resources from the JasperReports Server repository. Typically, users export data from their previous instance and import it into their new installation when upgrading JasperReports Server. The import utility is also used at installation time to load the sample data into the repository. This chapter covers the basic importing and exporting commands. For more information about command options, see the JasperReports Server Administrator Guide. This chapter contains the following sections:

Introduction Import-Export Configuration Files Changing Your Configuration Settings Adding an Additional JDBC Driver Running Import or Export

12.1

Introduction

As of release 5.5, the import-export functionality has been added the UI of JasperReports Server. This makes importing and exporting resources much more convenient for administrators. Using the UI to handle import and export is the recommended method. (Note: you must login as user jasperadmin to use this UI.) If you plan to use the command line import-export functionality, this chapter covers any additional pointers and/or steps that might be required to configure import-export. If you plan to use the JasperReports Server UI to handle your import-export tasks then this chapter does not apply to you. You can import and export resources from the command line by running either of these types of scripts: Type
Buildomatic Shell Script

Example Command
js-ant export-everything-ce -DexportFile=js-catalogexp.zip js-export-ce.sh --everything --output-file=js-catalogexp.zip

Description
Auto-configured buildomatic Ant script Import-export shell scripts

Both types of scripts are located in:

<js-install>/buildomatic

87

JasperReports Server Installation Guide You use the same commands, regardless of operating system, to run the buildomatic Ant scripts. The shell scripts, on the other hand, have different names: Windows Commands
js-import-ce.bat js-export-ce bat

Linux and Mac OSX Commands

js-import-ce.sh js-export-ce.sh

If you are running the js-import-ce.sh/bat or js-export-ce.sh/bat shell scripts, you might have to manually configure some databases as described in the following section.

12.2

Import-Export Configuration Files

Purpose
Import scripts for Windows and Linux, respectively Export scripts for Windows and Linux, respectively File that you must edit (already in place if you installed from the binary installer) Database and hibernate dialect settings file (put in place after you run js-ant gen-config) log4j.properties file controls output logging levels Spring configuration files All of the JasperReports Server jar files and the JDBC driver location

The import-export utility files are in the buildomatic folder. Use or modify these files to make configuration changes. File or Location
<js-install>/buildomatic/js-import-ce.bat and .sh <js-install>/buildomatic/js-export-ce.bat and .sh <js-install>/buildomatic/default_master.properties <js-install>/buildomatic/build_conf/default/ js.jdbc.properties <js-install>/buildomatic/conf_source/ieCE/ log4j.properties <js-install>/buildomatic/conf_source/ieCE/ applicationContext-*.xml <js-install>/buildomatic/conf_source/ieCE/lib

12.3

Changing Your Configuration Settings

If you are running the js-import-ce.bat/.sh or js-import-ce.bat/.sh shell scripts, then this section applies. When you install JasperReports Server from the installer binary, the import and export shell scripts are automatically configured. However, if you are installing the WAR file distribution you must modify the default_master.properties configuration file to include your database settings and perform other configuration tasks.

12.3.1

Creating a default_master.properties File

If you do not already have a <js-install>/buildomatic/default_master.properties file in place, create one. For instance, copy and rename buildomatic/sample_conf/postgresql_master.properties to buildomatic/ default_master.properties.

88

Configuring the Import-Export Utilities Perform the following steps: 1. Edit: <js-install>/buildomatic/default_master.properties

12.3.2

Location of Properties Files and JDBC Driver

Paths and file names for properties files are:

<js-install>/buildomatic/build_conf/default/js.jdbc.properties <js-install>/buildomatic/build_conf/default/js.quartz.properties (only for DB2 and

PostgreSQL) The JDBC driver file must be in this directory:

<js-install>buildomatic/conf_source/ieCE/lib

As of release 5.5, JDBC drivers for all five certified databases are found in the lib folder by default (DB2, MySQL, Oracle, PostgreSQL, and SQL Server).

12.3.3

Checking the js.jdbc.properties File

Table 12-1 and Table 12-2 contain sample settings for each database. The js.jdbc.properties file is automatically configured by buildomatic. But you can check the file to make sure the settings are correct for your environment.

Table 12-1 Database

PostgreSQL

JDBC Settings in the js.jdbc.properties File Sample Property Values

metadata.hibernate.dialect= com.jaspersoft.hibernate.dialect.PostgresqlNoBlobDialect metadata.jdbc.driverClassName=org.postgresql.Driver metadata.jdbc.url=jdbc:postgresql://localhost:5432/jasperserver metadata.jdbc.username=postgres metadata.jdbc.password=postgres or metadata.jdbc.encryptedPassword=encrypted-postgres metadata.hibernate.dialect=org.hibernate.dialect.MySQLInnoDBDialect (MySQL 5.1) metadata.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect (MySQL 5.5) metadata.jdbc.driverClassName=com.mysql.jdbc.Driver metadata.jdbc.url=jdbc:mysql://localhost:3306/ jasperserver?useUnicode=true&characterEncoding=UTF-8 metadata.jdbc.username=root metadata.jdbc.password=password or metadata.jdbc.encryptedPassword=encrypted-password

MySQL

12.3.4

Checking the js.quartz.properties File

The js.quartz.properties file is automatically configured by buildomatic. But you can check the file to make sure the settings are correct for your environment. This file is located at:
<js-install>/buildomatic/build_conf/default/js.quartz.properties

89

JasperReports Server Installation Guide Table 12-2 Database

PostgreSQL

Quartz Settings in the js.quartz.properties File Sample Property Values

quartz.delegateClass=org.quartz.impl.jdbcjobstore.PostgreSQLDelegate quartz.tablePrefix=QRTZ_ quartz.delegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate quartz.tablePrefix=QRTZ_

Other DBs

12.4

Adding an Additional JDBC Driver

JDBC drivers are already pre-configured for all certified databases. If you would like to use a different JDBC driver, you can copy it to the following folder:
<js-install>/buildomatic/conf_source/ieCE/lib

All Jaspersoft distributed JDBC drivers can be found at this location:

<js-install>/buildomatic/conf_source/db/<db-type>/jdbc

12.5
12.5.1

Running Import or Export

Running Import or Export from the UI

For complete information running import and export in the JasperReports Server UI, please refer to the JasperReports Server Administrator Guide. 12.5.1.1 Short Summary of Import-Export Functionality in the JasperReports Server UI

As of Release 5.5, import-export functionality is supported in the UI. You must login as the administrative user jasperadmin in order to access this functionality.
Export:

Export Single Set of Resources: Navigate to View > Repository. From this page, which shows a tree view of the JasperReports Server repository, you can right click a folder (on the left side of the page), or a resource (on the right side of the page) to get a context menu that has an export option. You can click export and you will be prompted for a file name and location to save the export zip file. Export All Resources: Navigate to Manage > Server Settings > Export tab. This page will export all resources from the repository (similar to js-export-ce --everything). You can click the Export button and you will be prompted for a file name and location to save the export zip file. Note: If you export all resources from a repository with a large number of resources, the execution of this command in the UI may take a long while. It is recommended to export from the command line in the case of a large number of resources.
Warning: Export from the UI in Release 5.1 has a bug. To work around the bug, you can export from the command line, or edit the export.zip file created by the UI export. See below 12.5.1.2, Workaround for Export bug in the 5.1 Release, for details

Import:

Import a zip file: Navigate to Manage > Server Settings > Import tab. Click the Import Data File Browse button to be prompted to choose a file from the file system. Then click the Import button to import resources.

90

Configuring the Import-Export Utilities 12.5.1.2 Workaround for Export bug in the 5.1 Release

In release 5.1 there is a known bug when exporting resources from the UI. There is incorrect metadata written to a file found inside the export zip file. To fix/workaround this problem you can export from the command line or update the incorrect metadata that is in the export zip file. To update the incorrect metadata, you should create a temporary folder and unpack the export.zip file to this folder. In the root of the folder you will find a file named index.xml. You can edit the index.xml file: Change: To: name=jsVersion value=5.0.0 CE name=jsVersion value=5.1.0 PRO

Then rezip the export.zip file.

12.5.2

Running Import from Buildomatic

The import target for ant has the following syntax: Windows: Linux and Mac OSX:
js-ant import -DimportFile=<filename> [-DimportArgs=<import-options>] ./js-ant import -DimportFile=<filename> [-DimportArgs=\<import-options>\]

The imported file is handled as a ZIP archive if its name ends in .zip, otherwise it is handled as a directory. The importArgs argument is optional and can contain more than one import option. On Linux, all double quotation marks () must be escaped with a backslash (\).
When performing a large import using js-ant, the server should be stopped (or put into a mode with reduced load) to avoid issues with caches, configuration, and security.

The following examples are typical import commands on Windows:

js-ant import-help-ce js-ant import -DimportFile=my-reports.zip js-ant import -DimportFile=my-datasources -DimportArgs=--update

The following examples are typical import commands on Linux:

./js-ant import-help-ce ./js-ant import -DimportFile=my-reports.zip ./js-ant import -DimportFile=my-datasources.zip -DimportArgs=\--update\

12.5.3

Running Export from Buildomatic

The export target for ant has the following syntax: Windows: Linux and Mac OSX:
js-ant export -DexportFile=<filename> -DexportArgs=<export-options> ./js-ant export -DexportFile=<filename> -DexportArgs=\<export-options>\

The export file format is a ZIP file or a set of files under a new directory name. If you specify the .zip extension for your output filename, a ZIP archive is created automatically. Otherwise, a directory with files and sub-directories is created as a uncompressed set of files.

91

JasperReports Server Installation Guide The exportArgs argument requires double quotation marks () and can contain more than one export option, as shown in these Windows examples:
js-ant export-help-ce js-ant export -DexportFile=my-domains.zip -DexportArgs=--uris /organizations/organization_1/Domains js-ant export -DexportFile=my-reports-and-users.zip -DexportArgs=--uris /organizations/organization_1/reports --users jasperadmin|organization_1,joeuser|organization_1

js-ant export -DexportFile=my-datasources -DexportArgs=--uris /organizations/organization_1/datasources --roles ROLE_USER js-ant export -DexportFile=js-everything.zip -DexportFile=js=--everything

On Linux, all double quotation marks () and other characters, such as the vertical bar (|), which separates login user and organization names must be escaped with a backslash (\). In addition, when listing user names, enclose the list in single quotation marks ('), as shown in this Linux example:
./js-ant export-help-ce ./js-ant export -DexportFile=my-reports-and-users.zip -DexportArgs=\--uris /organizations/organization_1/reports --users 'jasperadmin\|organization_1,joeuser\|organization_1'\

12.5.4

Running the Import-Export Shell Scripts

The import-export shell scripts are distinct from the buildomatic Ant import-export functionality. If you installed JasperReports Server using the WAR file distribution, you may need to configure the import-export shell scripts, as described in Chapter 12, Configuring the Import-Export Utilities, on page 87. If you installed JasperReports Server using the binary installer, the scripts are already properly configured. These import-export shell scripts are available for Windows, Linux, and Mac:

Windows:
<js-install>/buildomatic/js-export-ce.bat <js-install>/buildomatic/js-import-ce.bat

Linux and Mac:

<js-install>/buildomatic/js-export-ce.sh <js-install>/buildomatic/js-import-ce.sh When performing a large import, the server should be stopped (or put into a reduced load mode) to avoid issues with caches, configuration, and security. In addition, Jaspersoft recommends you stop the server instance before running a large export operation.

Run the import-export shell scripts with the help option to list the other options that you can use. For example:
js-export-ce.bat --help js-import-ce.sh --help

92

Troubleshooting

APPENDIX A TROUBLESHOOTING
This appendix contains the following sections:

Binary Installer Freezes Error Running Buildomatic Scripts Unable to Edit Files on Windows 7 Bash Shell for Solaris, IBM AIX, HP UX and FreeBSD Linux Installer Issue with Unknown Host Error Installation Error with Windows Path Mac OSX Issues Database-related Problems Application Server-related Problems Problems Importing and Exporting Data from the Repository Permissions Error in Overlay Upgrade with PostgreSQL and Bundled Jaspersoft Installation

A.1

Binary Installer Freezes

If you run the JasperReports Server installer on any platform and the installation fails, the following resources can help you find the source of the error.

A.1.1

Installer Log Files

If you run the JasperReports Server installer on any platform and there is an error, it is helpful to look at the log file created by the installer. This log file records the status and completion of installer operations. If your installer has had an explicit error, there may be a specific error message in the log. At a minimum, the log file should help narrow where the error has occurred even if there is not a specific error message. You can find the installer log in the following locations: Windows: <js-install>/installation.log Linux: Mac
<js-install>/installation.log <js-install>/installation.log

If you have tried multiple installs, make sure you view the most recent install log file. Then, you can submit the installation.log to Jaspersoft Technical Support. 93

JasperReports Server Installation Guide

A.1.2

Installer DebugTrace Mode

In addition, if you run the JasperReports Server installer on any platform and have a problem, you can run the installer a second time using the --debugtrace option. The --debugtrace option creates a binary output file that gives precise details about the execution of the installer and any problems encountered; this file can be analyzed by Jaspersoft Technical Support. To use the --debugtrace option, you must run the installer from the command line and specify an output filename. The precise command depends on your platform (Linux, Windows, or Mac OSX). For example, you can execute the installer with a command similar to the following:
jasperreports-server-cp-<ver>-linux-x64-installer.run --debugtrace install-trace-out.bin

When you run the installer in --debugtrace mode, the installer will take extra time to write the binary output file. The final size of the output file is approximately 10 mg. Contact Jaspersoft Technical Support to hand off of the binary file for analysis.

A.2

Error Running Buildomatic Scripts

The buildomatic scripts depend on both Java and Apache Ant. There are two common configuration errors when attempting to do an installation using these scripts (if you are not using the included, bundled Apache Ant).

A.2.1

Missing Java JDK

If you have the Java JRE (Java Runtime Environment) instead of the JDK, you will not have the additional utilities that are required. In particular, an error referring to the tools.jar might occur, as in the following message:
[exec] [exec] [exec] [exec] [exec] [exec] [exec] [exec] [exec] [ERROR] BUILD FAILURE [INFO] ---------------------------------------------------[INFO] Compilation failure Unable to locate the Javac Compiler in: c:\Program Files\Java\jdk1.6.0_10\jre\..\lib\tools.jar Please ensure you are using JDK 1.6 or above and not a JRE (the com.sun.tools.javac.Main class is required). In most cases you can change the location of your Java installation by setting the JAVA_HOME environment variable.

The solution is to download and install the Sun Java JDK, labeled as the Java SE Development Kit on the Sun web site. If you are upgrading JasperReports Server, you can also use the Java 1.6 JDK bundled in the previous version, as described in section 8.9.1, Handling JasperReports Server Customizations, on page 66.

A.2.2

Forgot to Copy the File ant-contrib.jar

If you are using your own version of Ant and your Ant instance does not have the ant-contrib.jar in the lib directory, you will get an error similar to the following:
BUILD FAILED c:\js-builds\jasperserver\buildomatic\install.xml:6:

Ant failed to create a task or type. To correct the error, copy <js-install>/buildomatic/extra-jars/ant-contrib.jar to your <apache-ant>/lib directory.

A.2.3

Failure with '$' Character in Passwords in Buildomatic Scripts

Ant is unable to accept more than one consecutive '$' character in passwords in buildomatic scripts. This issue only occurs when two dollar signs are used in a row. For example, $pas$word$ or pas$word$ will not fail. If you have two consecutive dollar signs, escape each with 4 dollar signs. For example, if you use pa$$word you would need to set it as pa$$$$$$$$word in the configuration file. Once you do this, JRS will have all data connections set to pa$$word.

94

Troubleshooting

A.2.4

Older Apache Ant Version

As of the release of JasperReports Server 4.0, Apache Ant version 1.8.1 or higher is required. There are improvements to error handling routines in the buildomatic js-install scripts which required the higher level of Ant. If you are using an older version of Ant, you will get an error similar to the following:
BUILD FAILED c:\js-builds\jasperserver\buildomatic\install.xml:37: Problem: failed to create task or type componentdef

To check your version of Ant and verify that it is at a high enough level, enter:
ant -version

If you have a lower version of Ant, check to see if it is set in your class path by entering:
echo $CLASSPATH

To use the JasperReports Server version of Ant, update your CLASSPATH variable to point at the <js-install>/apache-ant/bin directory.

A.3

Unable to Edit Files on Windows 7

In some cases, you may want to manually edit files under your C:/Jaspersoft directory during or after installation. For security reasons, Windows 7 doesn't allow normal processes to change files in many folders including the Program Files folder, for instance. When you attempt to edit these files, you may see an error such as the following: You dont have permission to save in this location. Contact the administrator to obtain permission. You can edit these files by running as administrator. For example, to edit these files with Notepad on Windows 7: Click Start > All Programs > Accessories, right-click Notepad, and click Run as administrator.

A.4

Bash Shell for Solaris, IBM AIX, HP UX and FreeBSD

To execute the js-install shell scripts described in Chapter 5 of this guide, the bash shell is required. The js-install and js-upgrade scripts which are found in the buildomatic folder are the following:
js-install.sh js-upgrade-newdb.sh js-upgrade-samedb.sh

The bash shell is not included by default in all Unix platforms. In the case where the bash shell is not available, it is necessary to download and install the bash shell. Bash shells are available for the following platforms: Solaris IBM AIX HP UX FreeBSD Alternatively, you can manually run the same buildomatic Ant targets that are run by the js-install script. These Ant targets are listed in Troubleshooting Your JasperReports Server Configuration on page 31. Also, check that you have updated your local Ant to include the ant-contrib.jar which supports conditional logic in Ant. The ant-contrib.jar in found in the location below and it should be copied to your <ant_home>/lib folder:
buildomatic/extra-jars/ant-contrib.jar

For updating your local Ant instance with the ant-contrib.jar see Section A.2.2 above (Forgot to Copy the File antcontrib.jar). If you try and use the bundled ant that is included with the JasperServer WAR file Distribution ZIP package, you may get the same non-bash syntax error. You may get the error below, for example: 95

JasperReports Server Installation Guide

js-ant help-install ANT_HOME=../apache-ant: is not an identifier

If you have the bash shell installed, you can try executing the js-ant command by calling bash explicitly, for example:
bash js-ant help-install

A.5

Linux Installer Issue with Unknown Host Error

If a Linux server does not have proper hostname entries in the /etc/hosts file, it is possible to get installer errors. The installer carries out an import operation in order to load the core, minimal data into the repository database. This import operation can fail if the host is not configured. If the import operation fails during installation, the installation will also fail. However, there should be an installation.log in the root of the installation folder to help debug the problem. The installation.log is located here:
<js-install>/installation.log

An improperly configured hosts file typically causes the log, or error messages displayed on the console, to contain error messages such as these:
Caused by: java.net.NoRouteToHostException: No route to host com.mysql.jdbc.exceptions.jdbc4.CommunicationsException: Communications link failure ERROR Cache:145 - Unable to set localhost. This prevents creation of a GUID java.net.UnknownHostException org.quartz.SchedulerException: Couldn't get host name! To fix the /etc/hosts file:

1.

Include entries that look similar to these: 127.0.0.1 172.17.5.0 For instance: 127.0.0.1 172.17.5.0 localhost.localdomain myhost.jaspersoft.com localhost myhost localhost.localdomain myhost.mydomain.com localhost myhost

2.

Also, you can double check the file /etc/sysconfig/network (if it exists). In this file it would be similar to the following: HOSTNAME=myhost

3.

After fixing the /etc/hosts file, reinstall JasperReports Server.

96

Troubleshooting

A.6

Installation Error with Windows Path

If the length to the path to the war archive is longer than the maximum allowed by Windows, you will get an error message similar to:
BUILD FAILED c:\jaspers\war_file_installations\war_mysql_500\jasperreports-server-5.0bin\buildomatic\bin\db-common.xml:871: The following error occurred while executing this line: c:\jaspers\war_file_installations\war_mysql_500\jasperreports-server-5.0bin\buildomatic\bin\import-export.xml:264: The following error occurred while executing this line: c:\jaspers\war_file_installations\war_mysql_500\jasperreports-server-5.0bin\buildomatic\bin\import-export.xml:158: java.io.IOException: Cannot run program "C:\Program Files\Java\jdk1.6.0_38\jre\bin\java.exe": CreateProcess error=206, The filename or extension is too long at java.lang.ProcessBuilder.start(ProcessBuilder.java:460) at java.lang.Runtime.exec(Runtime.java:593)

You will need to move the war archive to reduce the path length. More information is available from Microsoft at: http://msdn.microsoft.com/en-us/library/windows/desktop/ aa365247(v=vs.85).aspx.

A.7
A.7.1

Mac OSX Issues

Problem Starting JasperReports Server on Mac

Jaspersoft has seen some issues caused by the improper shutdown of the Tomcat included with the JasperReports Server. This could be related to the machine being shutdown while Tomcat is running. When the Tomcat scripts start Tomcat, they write a pid (Process ID) file to the Tomcat folder. Tomcat uses this to determine whether the Tomcat instance is already running. When Tomcat is shutdown, this pid file is removed. However, if the pid file is not removed on shutdown, Tomcat will fail to start up. You may see this when you double-click the jasperServerStart.app startup. It will seem like JasperReports Server is starting up but it never actually starts up. In order to recover from this issue, you will need to manually delete the pid file.
Delete catalina.pid using Finder:

1. 2.

Navigate to the <js-install>/tomcat/temp folder For instance: /Applications/jasperreports-server-<ver>/tomcat/temp Delete catalina.pid

Delete the catalina.pid file using Terminal shell:

1. 2. 3.

Open a Terminal shell (Finder > Go > Utilities > Terminal Icon) Navigate to the <js-install>/tomcat/temp folder For instance: /Applications/jasperreports-server-<ver>/tomcat/temp Enter the following command:
rm catalina.pid

97

JasperReports Server Installation Guide

To start and stop the PostgreSQL and Tomcat components separately from the command line shell:

1. 2. 3.

Open a Terminal shell (Finder > Go > Utilities > Terminal Icon). Navigate to the <js-install> folder. For instance: /Applications/jasperreports-server-<ver> To Start:
./ctlscript start postgresql ./ctlscript start tomcat

4.

To shutdown:
./ctlscript stop

or
./ctlscript stop tomcat ./ctlscript stop postgresql

A.7.2

Installation Error on Mac OSX 10.8 (Lion)

When trying to install Jaspersoft on Mac OSX 10.8 (Lion) you might see the pop-up message jasperreports-server-5.2-osxx86-installer.app can't be opened because it is from an unidentified developer. Your security preferences allow installation of only apps from the Mac App Store and identified developers. If you see that message, perform the following procedure: 1. 2. Right-click or Control-click the application and choose Open. Click the Open button at the next dialog warning to launch the installer.

A.8
A.8.1

Database-related Problems
Database Connectivity Errors

The most common problems encountered with a new JasperReports Server instance are database configuration problems. If the connection fails, perhaps the application server cannot find the driver for the data source. For example, in a default installation of JasperReports Server, Tomcat looks for data source drivers in <js-install>/apache-tomcat/lib. If the driver is not there, put a copy of the driver in this directory and restart Tomcat. This section contains information that may help resolve other connectivity issues. A.8.1.1 Testing the Database Connection

The simplest database configuration problem is an incorrect user name or password. If you encounter database problems upon startup or login, check the user name and password by logging directly into your RDBMS as described in the following sections. You can connect to your database using the database configuration settings that are found in JasperReports Server. This validates the database hostname, port, username, and password that are being used. If you are having trouble logging into JasperReports Server on the login page, you can check the users and passwords that exist by viewing the contents of the jasperserver.JIUser table. A.8.1.2 Logging into PostgreSQL

Run the PostgreSQL client from the command line and try to connect to the database. For example:
psql -U postgres jasperserver

A.8.1.3

Logging into MySQL

Run the MySQL client from the command line and try to log in directly using the root user, for example:
<mysql>/bin/mysql -u root -p

98

Troubleshooting You are prompted for a password for the user you specified on the command line. Enter the appropriate password to login. The default password used in the sample configuration scripts is password (jasperadmin in 2.1 and earlier). A.8.1.4

Logging into Oracle

Start SQL*Plus and try to log into Oracle directly. Three users are created during installation:
jasperserver - schema user for the JasperReports Server metadata. sugarcrm - schema user for the SugarCRM sample data. foodmart - schema user for the foodmart sample data.

To log in as each of these users, supply the password specified during installation. A.8.1.5 Logging into Microsoft SQL Server

Run the sqlcmd and try to log into MSSQL Server directly. For example:
sqlcmd -S localhost\jasperserver -d jasperserver -U jasperadmin -P password

A.8.2

Case Sensitive Collation in SQL Server

In Microsoft SQL Server, setting the collation to be case-sensitive is not supported. When collation is case-sensitive in SQL Server, column and table names are also treated as case-sensitive. This can happen when setting a locale that includes case-sensitive collation and will cause an error:
[sql] Failed to execute: INSERT INTO JIUserRole (userId,roleId) select u.id, r.id from JIUser u, JIRole r where u.username = \'anonymousUser\' and r.roleName = \'ROLE_ANONYMOUS\' [sql] com.microsoft.sqlserver.jdbc.SQLServerException: Invalid column name \'roleName\'

Use a different locale or remove the case-sensitivity setting.

A.8.3

Maximum Packet Size in MySQL

If you are upgrading or importing into a MySQL database and your repository contains large objects such as images, you may see an error such as:
ERROR 1153 (08S01): Got a packet bigger than 'max_allowed_packet' bytes

The default max_allowed_packet on the MySQL server is 1M (one Megabyte = 1,048,576 bytes). The most effective fix is to change this value in the server configuration to accommodate the largest resource stored in your repository. The server configuration file is typically named my.cnf (or my.ini) and is located in the MySQL root directory, although this may vary. Change the configuration setting to a larger value, for example:
max_allowed_packet = 16M

For more information, see http://dev.mysql.com/doc/refman/5.0/en/packet-too-large.html. After changing this value, restart the MySQL server. Then perform the upgrade or import step again.

A.8.4

Case Sensitivity for Table and Column Names

Some databases are case-sensitive with respect to table names and will consider customer and Customer to be two different tables. If JasperReports Server is using a case-sensitive database, its important that the table names specified in query strings in the JRXML file of a saved report match the actual table names found in the database. A mismatch may occur if you are transferring data from one database to another, which may cause the capitalization of table names to change. Under Windows MySQL, table and column names are not case-sensitive. Under Linux MySQL, table and column names are case-sensitive. Linux MySQL can be configured to be non-case-sensitive by setting the configuration parameter lower_case_table_names to 1 in the my.ini or my.cnf file. For more information search the MySQL documentation for a section about identifier case sensitivity. 99

JasperReports Server Installation Guide Table and column names in Oracle and PostgreSQL are case-sensitive.

A.8.5

PostgreSQL: Job Scheduling Error

If the Quartz settings under the PostgreSQL database have not been updated to specify the driver delegate class specific to PostgreSQL you will get errors when you try and run a scheduled report. The errors would look similar to the following:
Error while fetching Quartz runtime information org.quartz.JobPersistenceException: Couldn't obtain triggers: Bad value for type int org.postgresql.util.PSQLException: Bad value for type int

If you see this error you will need to check your Quartz properties file found at the following location:
<tomcat>/webapps/jasperserver-pro/WEB-INF/js.quartz.properties

Make sure that the following property does not have the standard driver delegate, but instead has the PostgreSQL specific driver delegate. It should look like the following for PostgreSQL:
quartz.delegateClass=org.quartz.impl.jdbcjobstore.PostgreSQLDelegate

A.8.6

Oracle js-install Script Hangs with Oracle 10g

If you plan to run the js-install script when installing to an Oracle database instance, check for the appropriate JDBC driver version. The default JDBC driver used for Oracle tends to be specific for newer Oracle versions. If you are installing to an older version of Oracle then the newer JDBC driver can cause execution to hang. The default JDBC driver for Oracle can be seen in your buildomatic/default_master.properties file:
<js-install>/buildomatic/default_master.properites <js-install>/buildomatic/sample_conf/oracle_master.properties

(final file name and location) (original file)

The settings for the default JDBC driver for Oracle are:
# maven.jdbc.artifactId=ojdbc5 # maven.jdbc.version=11.2.0

The settings above are commented out. Nevertheless, this is the JDBC driver that is used by default. These settings are appropriate for an Oracle version 11.2 instance. If you are using Oracle 10.2, remove the comments from these settings and change them to:
maven.jdbc.artifactId=ojdbc14 maven.jdbc.version=10.2.0

The location of the Oracle JDBC drivers is here:

<js-install>/buildomatic/conf_source/db/oracle/jdbc

A.8.7

Performance Issues with Oracle JDBC Queries

Setting the Oracle database localization option defaultNChar to true can substantially impact the performance of JDBC queries. When defaultNChar is set to true, the database will implicitly convert all CHAR data into NCHAR when you access CHAR columns. If you do not need to support UTF-8 for your Oracle database, you can omit this setting. The option you need and how to set it depends on your version of Java, your application server, and how it is deployed. For information about changing a JVM option setting for your particular environment, see your application server documentation. To change this setting on Windows, enter a command such as the following at the command line:
set JAVA_OPTS=%JAVA_OPTS% -Doracle.jdbc.defaultNChar=false

To change this setting on Linux, enter a command such as the following at the command line:
export JAVA_OPTS="$JAVA_OPTS -Doracle.jdbc.defaultNChar=false"

100

Troubleshooting

A.8.8

Using an Oracle Service Name

If your Oracle database is configured to use a service name instead of an Oracle system identifier (SID), set up the service name by updating your default_master.properties file before using buildomatic:
<js-install>/buildomatic/default_master.properties

In default_master.properties, uncomment the serviceName property and enter your Oracle service name, for example:
serviceName=ORCL

When you are using an Oracle service name, make sure not to set the SID or dbPort in the default_master.properties file.

A.8.9

Oracle Error on Upgrade when PL/SQL Not Enabled

If you are upgrading to JasperReports Server version 5.0 or later using the js-upgrade-samedb.sh/bat script, you can encounter an error if Oracle's Procedural Language (PL/SQL) is not enabled. The upgrade script used to upgrade to a 4.7 database from a 4.5 database requires the PL/SQL language to be enabled. The script is located here: buildomatic/install_resources/sql/oracle/upgrade-oracle-4.5.0-4.7.0-pro.plsql The error you encounter might look something like the following: [advanced-sql] PLS-00103: Encountered the symbol end-of-file If your PL/SQL language is not enabled please consult the documentation for your Oracle database to enable PL/SQL.

A.8.10

Error Running Scheduled Report

If you setup a scheduled report, chose to run it, and chose to save it as HTML or RTF, the report size can potentially get quite large. If you are running MySQL and you get the following error:
JDBC exception on Hibernate data access org.hibernate.exception.GenericJDBCException: could not insert

the problem may be the default size of the MySQL blob datatype. You can increase the size of this datatype by updating your my.ini or my.cnf MySQL configuration file with the following setting:
max_allowed_packet=32M

A.8.11

Error Running a Report

If you can log into JasperReports Server but encounter an error when running a report within it, you can browse the repository to identify and resolve the problem. One common problem with an individual report is the data source being used. To validate a data source connection: 1. 2. 3. 4. 5. Log into JasperReports Server as a user with administrative permissions and locate the report unit that returns errors. Select the report and click the Edit button in the toolbar to identify the data source the report uses. The data source name is found on the fourth edit page. Select this data source in the repository and click the Edit button in the toolbar. Review the information specified for this data source. Click the Test Connection button in order to validate the connection. If the connection fails, perhaps the application server cannot find the driver for the data source. For example, in a default installation of JasperReports Server, Tomcat looks for data source drivers in <js-install>/apache-tomcat/lib. 6. 7. Click Save or Cancel when you are done. Test your report. If it still returns errors, edit the data source again and try checking other values, such as the port used by the database.

101

JasperReports Server Installation Guide

A.9
A.9.1

Application Server-related Problems

Memory Issues Running Under Tomcat

If you experience problems related to the release of memory or to container tag pooling, the following steps might solve the problem: 1. 2. Set the following parameter in the global $CATALINA_BASE/conf/web.xml:
enablepooling = false

Restart Tomcat.

A.9.2

Java Out of Memory Error

If you encounter a Java out of memory error, try increasing your Java heap size setting. See section 6.1, Setting JVM Options for Application Servers, on page 39. As a minimum, add -Xms1024m -Xmx2048m to your JAVA_OPTS setting. This Java option is set within the application server, so you must set it then restart your application server.

A.9.3

Configuration File Locations

JasperReports Server configuration properties are found in the following files, depending on your application server. The following list shows the location of the properties for supported application servers: Tomcat: <tomcat>/webapps/jasperserver-pro/META-INF/context.xml <tomcat>/webapps/jasperserver-pro/WEB-INF/hibernate.properties <tomcat>/apache-tomcat/webapps/jasperserver-pro/WEB-INF/web.xml <tomcat>/apache-tomcat/config/Catalina/localhost/jasperserver-pro.xml JBoss 5: (JNDI config) (delete: see below)

<jboss>/server/default/deploy/js-postgresql-ds.xml or js-oracle-ds.xml or js-<database name>-ds.xml <jboss>/server/default/deploy/jasperserver-pro.war/WEB-INF/hibernate.properties <jboss>/server/default/deploy/jasperserver-pro.war/WEB-INF/web.xml <jboss>/server/default/deploy/jasperserver-pro.war/WEB-INF/jboss-web.xml

GlassFish: <glassfish>/domains/domain1/autodeploy/jasperserver-pro.war/WEB-INF/hibernate.properties <glassfish>/domains/domain1/autodeploy/jasperserver-pro.war/WEB-INF/js.quartz.properties <glassfish>/domains/domain1/config/domain.xml

A.9.4

Context.xml under Tomcat: Special Case

If you deploy multiple instances of JasperServer to Tomcat, the context.xml (database connection configuration) can be superseded by a file in this location: <tomcat>/conf/Catalina/localhost/jasperserver-pro.xml file. This is the case with some Tomcat versions before Tomcat 7. When JasperServer is deployed, the context.xml will be copied to <tomcat>/conf/Catalina/localhost/ jasperserver-pro.xml (Tomcat does this by default). Now, if you make changes to your <tomcat>/webapps/jasperserver-pro/META-INF/context.xml, Tomcat will not see them. Instead, the jasperserver-pro.xml will be used. This is confusing, but is the way that Tomcat operates. If you edit your context.xml to fix a database problem:
<tomcat>/webapps/jasperserver-pro/META-INF/context.xml

Remember to delete the jasperserver-pro.xml file:

<tomcat>/conf/Catalina/localhost/jasperserver-pro.xml

(delete this file)

102

Troubleshooting

A.9.5

Tomcat 6 Installed Using apt-get

If you are installing JasperReports Server to an instance of Tomcat that has been installed using a package managers such as apt-get, yum, or rpm then you can use the CATALINA_HOME and CATALINA_BASE properties found in your default_master.properties file. Go to the section of the default_master.properties that looks like this:
# Tomcat app server root dir appServerDir = C:\\Program Files\\Apache Software Foundation\\Tomcat 7.0 # appServerDir = /home/devuser/apache-tomcat-7.0.26 # if linux package managed tomcat instance, set two properties below # CATALINA_HOME = /usr/share/tomcat6 # CATALINA_BASE = /var/lib/tomcat6

and change it to the following:

# Tomcat app server root dir # appServerDir = C:\\Program Files\\Apache Software Foundation\\Tomcat 7.0 # appServerDir = /home/devuser/apache-tomcat-7.0.26 # if linux package managed tomcat instance, set two properties below CATALINA_HOME = /usr/share/tomcat6 CATALINA_BASE = /var/lib/tomcat6

Note that you must set both CATALINA_HOME and CATALINA_BASE.

A.9.6
A.9.6.1

GlassFish Modifications
Using a Custom Domain

If your application server is GlassFish and youre using a custom domain, set up the following authentication information in the default_master.properties:
# Glassfish domain name (default is domain1) glassfishDomain=domain1 # Glassfish domain port (default is 4848), user (default is admin) and password. # Uncomment and set up next parameters if you install JasperServer to the custom Glassfish domain (not default) #glassfishPort=4848 #glassfishUser=admin #AS_ADMIN_PASSWORD=adminadmin

A.9.6.2

Using GlassFish 3.1.0

There is a known issue with GlassFish 3.1.0 where Java JVM options are not properly set. This issue is fixed in GlassFish 3.1.1 and later.
To set the JVM options in GlassFish 3.1.0:

1. 2.

Open this buildomatic property file:

<js-install>/buildomatic/default_master.properties

Add the glassfishPort property as follows:

glassfishPort=4848

A.9.6.3

Cant Upload Files on GlassFish 3.1.2

There is a known issue with file upload on GlassFish 3.1.2 which prevents you from uploading files to the JasperReports Server (GLASSFISH 18446). This issue is resolved in the 3.1.2.2 release, which is a microrelease that resolves this and other critical issues.

103

JasperReports Server Installation Guide A.9.6.4 Requests to Single Permissions REST2 Service fail on GlassFish

Requests to Single Permissions REST2 service are failing on GlassFish with the following error:
400 Invalid URI: Encoded slashes are not allowed by default. To enable encodedslashes, set the property com.sun.grizzly.util.buf.UDecoder.ALLOW_ENCODED_SLASH to true

To fix this issue, perform the following command:

./bin/asadmin create-jvm-options Dcom.sun.grizzly.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true

A.9.7
A.9.7.1

JBoss Modifications
JBoss 7 Startup Error

JBoss7 has a default startup time period. If your JBoss 7 takes longer than 60 seconds to startup or deploy, you may receive the following error:
(DeploymentScanner-threads - 1) Did not receive a response to the deployment operation within the allowed timeout period [60 seconds]. Check the server configuration file and the server logs to find more about the status of the deployment.

To fix this, you need to increase your deployment-timeout setting as follows: 1. 2. 3. Change to the JBoss standalone configuration directory.
cd <jboss>/standalone/configuration

Open the standalone.xml file. Look for the <subsystem xmlns=urn:jboss:domain:deployment-scanner:1.1> element, for example:
<subsystem xmlns=urn:jboss:domain:deployment-scanner:1.1> <deployment-scanner path=deployments relative-to=jboss.server.base.dir scaninterval=5000/> </subsystem>

4.

Edit this to add or set the attribute deployment-timeout to the desired amount of time in seconds, for example:
<subsystem xmlns=urn:jboss:domain:deployment-scanner:1.1> <deployment-scanner path=deployments relative-to=jboss.server.base.dir scaninterval=5000 deployment-timeout=600/> </subsystem>

5.

Save the file. On server restart, your system will have the specified amount of time to start up.

A.9.7.2

JBoss Large INFO Log Message on Drill-through

JBoss has an internal mechanism to track and log information on unclosed JDBC connections. Jaspersoft OLAP Views leaves a connection open for performance reasons when doing a drill-through. In this case, JBoss puts a large INFO level message into the server.log.
To silence this INFO message, perform these steps:

1. 2.

Open the JBoss log4j configuration file for editing:

<jboss>/server/default/conf/jboss-log4j.xml

Set the logging level for the CachedConnectionManager class to the following value:
<category name=org.jboss.resource.connectionmanager.CachedConnectionManager> <priority value=WARN/> </category>

104

Troubleshooting A.9.7.3 JBoss 5.0.1 and 5.1.x Error

With JBoss 5.0.1 and 5.1.x, you might see the following error:
org.jboss.xb.binding.JBossXBRuntimeException: Failed to create a new SAX parser Caused by: java.lang.ClassCastException

This error might have occurred with older releases of JasperReports Server. Newer releases use a jar newer than 2.7.1 so this problem should not occur. Additionally, the xercesImpl-*.jar is automatically deleted when installing using the buildomatic scripts. This is a class conflict with the xercesImpl-2.7.1.jar in JasperReports Server. To correct it, delete the following file:
<jboss>/server/default/deploy/jasperserver-pro.war/WEB-INF/lib/xercesImpl-*.jar When running the buildomatic scripts to deploy to JBoss, the xercesImpl-*.jar file is automatically deleted in order to fix this problem.

105

JasperReports Server Installation Guide A.9.7.4 AttachmentStore Error in JBoss 5.1

With JBoss 5.1 you might see the following error:

DEPLOYMENTS IN ERROR: Deployment AttachmentStore is in error due to: java.lang.IllegalArgumentException: Wrong arguments. new for target java.lang.reflect.Constructor expected=[java.net.URI] actual=[java.io.File]

This is a known JBoss issue. The resolution is to edit the file jboss-5.1.0.GA\server\default\conf\bootstrap\profile.xml to include java.io.File:
<bean name=AttachmentStore class=org.jboss.system.server.profileservice.repository.AbstractAttachmentStore> <constructor><parameter class=java.io.File><inject bean=BootstrapProfileFactory property=attachmentStoreRoot /></parameter></constructor> <property name=mainDeployer><inject bean=MainDeployer /></property> <property name=serializer><inject bean=AttachmentsSerializer /></property> <property name=persistenceFactory><inject bean=PersistenceFactory /></property> </bean>

A.9.7.5

Using a Non-default JBoss Profile

If your application server is JBoss and youre using a profile other than the default, you need to set the jboss.profile property before running the js-install script in section 5.2, Installing the WAR File Using js-install Scripts, on page 32: 1. 2. Open this buildomatic property file:
<js-install>/buildomatic/build_conf/default/app.srv.properties

Uncomment the jboss.profile property and change the profile name as follows: from
# jboss.profile = default

to
jboss.profile = <your_profile>

A.9.7.6

Using JBoss with Non-Latin Characters

If your application server is JBoss, and your organization is created with non-Latin characters, you will need to edit the standalone.xml configuration file. 1. 2. Edit <jboss-home>/standalone/configuration/standalone.xml Add after <extensions> tag new tag:
<extensions> ...... </extensions> <system-properties> <property name=org.apache.catalina.connector.URI_ENCODING value=UTF-8/> <property name=org.apache.catalina.connector.USE_BODY_ENCODING_FOR_QUERY_STRING value=true/> </system-properties>

106

Troubleshooting A.9.7.7 JBoss 4.2 XML/A Connection Fix

JBoss 4.2 includes the JBossWS service as a standard, default feature. JasperReports Server has web services support for XML/A connections. The web services classes in JasperReports Server and JBoss can conflict and cause the following error when attempting to utilize a JasperReports Server XML/A connection:
javax.xml.soap.SOAPException: Unable to create message factory for SOAP: org.jboss.ws.core.soap.MessageFactoryImpl

To prevent the web services class conflict, set the special Java JVM options for JBoss 4.2, as described in section 6.1.1, Tomcat and JBoss JVM Options, on page 39.

A.9.8
A.9.8.1

Websphere Modifications
Page Not Found Error on Login

This error is seen during a WebSphere installation when the user attempts to log into JasperReports Server. After typing in a correct user ID and password, the user sees an error page: Page cannot be found, HTTP 404 Some WebSphere versions or fix packs have modified code that processes web server filters incorrectly. Components with the /* url pattern get affected by this. JasperReports Server uses the Spring framework for authentication and it is mapped using a filter chain with the /* url pattern. You need to set a special property that WebSphere provides to solve this problem.
To solve the Page Not Found Error on Login:

1. 2. 3.

Login into WebSphere Administrative Console. Navigate to Application Servers > <server> > Web Container Settings > Web Container > Custom Properties. Create a new property with the following attributes:
name: com.ibm.ws.webcontainer.invokefilterscompatibility value: true

4. 5.

Save the master configuration. Restart the WebSphere server.

A.9.9

Disabling User Session Persistence in Application Servers

JasperReports Server stores non-serializable data in its user sessions, which can cause errors after restarting your application server:
Exception loading sessions from persistent storage Cause: java.io.NotSerializableException ...

The errors appear in the JasperReports Server log when users log in after the application server has been restarted. The errors do not appear to users, and they have no impact on JasperReports Server operations. Because JasperReports Server user sessions are not persistent, you can configure your application server to disable persistence and avoid the error. For example, in Apache-Tomcat 5.5, 6, and 7 edit the file <tomcat>/conf/context.xml and locate the following lines:
<!-- Uncomment this to disable session persistence across Tomcat restarts --> <!-<Manager pathname=pathname= /> -->

Remove the comment markers from lines 2 and 4 above, then restart Apache-Tomcat for the change to take effect. For other application servers, refer to the product documentation.

107

JasperReports Server Installation Guide

A.9.10

Session Error Using JasperReports Server and Tomcat 7

On some versions of Tomcat 7, a session error might occur while running reports, with the log error A request has been denied as a potential CSRF attack. This is due to a known conflict between security settings in Direct Web Remote library (DWR) 2.x and some versions of Tomcat 7.0.x:

Tomcat 7 sets httpOnly on session ID cookies to safeguard against cross-site scripting (XSS) attacks. DWR 2.x uses session ID cookies to safeguard against cross-site request forgery (CSRF). Disabling httpOnly for cookies in Tomcat OR Allowing requests from other domains in DWR

To work around this problem, you must modify these safeguards by doing one of the following:

For more information on the security impact and relative risks of these two choices, see, for example, the Cross-site Scripting and Cross-site Request Forgery pages at the Open Web Application Security Project (OWASP). A.9.10.1 Disabling httpOnly for Cookies in Tomcat

The application server that hosts JasperReports Server handles the session cookie. To prevent malicious scripts on a client from accessing the session cookie, and thus the user connection, Tomcat 7 is set to use httpOnly cookies. This tells the browser that only the server may access the cookie, not scripts running on the client. When enabled, this setting safeguards against XSS attacks. You can disable this by setting httpOnly in the file <tomcat>/conf/context.xml:
<Context useHttpOnly=false> ... </Context>

A.9.10.2

Allowing Requests from Other Domains in DWR

DWR is a server-side component used for Input Controls. By default, DWR uses session ID cookies to prevent against crosssite request forgery. You can disable the protection in DWR by setting the crossDomainSessionSecurity parameter for the dwr servlet in the file <tomcat>\webapps\jasperserver-pro\WEB-INF\web.xml:
<servlet> <servlet-name>dwr</servlet-name> <servlet-class>org.directwebremoting.spring.DwrSpringServlet</servlet-class> ... <init-param> <param-name>crossDomainSessionSecurity</param-name> <param-value>false</param-value> </init-param> </servlet>

A.10
A.10.1

Problems Importing and Exporting Data from the Repository

Exporting a Repository That Contains UTF-8

The following errors may happen when you have international characters in repository objects, for example, in user IDs. A.10.1.1 Error During Export

Upgrading typically requires doing an export operation on your database. If you are using MySQL and getting this null pointer exception, it may be due to an incorrect character in the file js.jdbc.properties: 108

Troubleshooting
java.lang.NullPointerException ResourceExporter.exportResource(ResourceExporter.java:258)

Check the URL in this file in <js-install>buildomatic/build_conf/default/; it should look like the following:
jdbc:mysql://localhost:3306/jasperserver?useUnicode=true&characterEncoding=UTF-8

Note the ampersand & character. It is incorrect if it appears as &amp;. The &amp; is only correct in an HTML or XML context. It is incorrect in a properties file.

109

JasperReports Server Installation Guide A.10.1.2 Error During Export from Repository on Oracle

Oracle requires a specific JVM property to handle UTF-8 characters properly. When this error happens, the export is empty and an error occurs when attempting to compress the result:
ERROR ExporterImpl:129 - java.util.zip.ZipException: ZIP file must have at least one entry

If you have stored your repository database on an Oracle RDBMS, modify the last line of both <js-install>/ buildomatic/js-export.* files as follows: From: To:
java -classpath ... java -Doracle.jdbc.defaultNChar=true -classpath ...

A.11
A.11.1

Problems with Upgrade

Include Audit Events on Upgrade

If you have auditing enabled and you run upgrade using js-upgrade-newdb.bat/sh, audit events are not imported by default. To import audit events, you need to run an additional command after the after the js-upgrade-newdb script completes. To do this, change to the buildomatic directory:
cd <js-install>/buildomatic

Then run one of the following commands (for example):

js-import.bat --input-zip=js-my-export-all.zip --include-audit-events (Windows) js-import.sh --input-zip=js-my-export-all.zip --include-audit-events (Linux)

or
ant import -DimportFile=js-my-export-all.zip -DimportArgs=--include-audit-events

These commands reimport all resources from the specified export file. Existing resources will not be overwritten and the audit event will be added.
When using either import utility, the server must be stopped to avoid issues with caches, configuration, and security.

A.12

Installing on Windows XP if Memory Error

With some instances of Windows XP, we have found that JasperReports Server is not able to cleanly startup after running the binary installer (i.e. jasperreports-server-<ver>-windows-x86-installer.exe). The problem has been that Windows XP is not providing enough contiguous memory for JasperReports Server to successfully startup. When this is the case, there will be an error message seen in the Apache Tomcat log (<js-install>/apache-tomcat/logs/ Catalina.out) similar to this: Not enough reserve enough space for object heap The solution to this issue is to either decrease the Java memory requested by the Tomcat application, or to install to a 64 bit Windows machine (which is able to map more system memory). To decrease the Java memory requested by the Tomcat service put into place by the binary installer, you can utilize the following steps:

Edit the file <js-install>/apache-tomcat/bin/service.bat Look for the line (toward the end of the file) that defines the Java memory settings

-Xms512M;-Xmx1024M

Change this value to the following

110

Troubleshooting

-Xms256M;-Xmx512M cd C:\Jaspersoft\jasperreports-server-<ver>\apache-tomcat\scripts

Open a Windows Command shell, Start > Run > cmd (Note: after you run the following command the CMD shell will disappear)
serviceinstall.bat REMOVE

Next, make sure that your PostgreSQL database is running Go to the Windows Services Panel, and check the status of jasperreportsPostgreSQL Click to start the PostgreSQL service Open a new Windows Command shell, Start > Run > cmd

cd C:\Jaspersoft\jasperreports-server-<ver>\apache-tomcat\scripts

(Note: after you run the following command the CMD shell will disappear)
serviceinstall.bat INSTALL

The command above will install the Tomcat service and leave Tomcat running Log into JasperReports Server to see that everything is working cleanly

http://localhost:8080/jasperserver-pro

A.13
A.13.1

Property File Updates

Owasp.CsrfGuard.properties - Security File

There is a set of property files that help control the settings for the JasperReports Server functionality that prevents Cross-Site Request Forgery (CSRF). The key files are described in the JasperReports Server Administrator Guide. One of these properties files refers to the JasperReports Server webapp name, but it is not currently automatically updated by the installation procedure. This file is at the following location:
<appserver-path>/jasperserver-pro/WEB-INF/esapi/Owasp.CsrfGuard.properties

If you change the name of your webapp from the default of jasperserver-pro, then you will also need to manually update the Owasp.CsrfGuard.properties file. So, if you modify your default.master.properties like so:
# webAppNamePro = jasperserver-pro webAppNamePro = jasperserver-inst2

And then do an installation (using the js-install.sh scripts), you will need to edit Owasp.CsrfGuard.properties like so: Change:
org.owasp.csrfguard.NewTokenLandingPage=/jasperserver-pro/login.html org.owasp.csrfguard.action.Redirect.Page=/jasperserver-pro/login.html

To:
org.owasp.csrfguard.NewTokenLandingPage=/jasperserver-inst2/login.html org.owasp.csrfguard.action.Redirect.Page=/jasperserver-inst2/login.html

This issue is planned to be fixed in the next JasperReports Server release.

A.14

Permissions Error in Overlay Upgrade with PostgreSQL and Bundled Jaspersoft Installation

If you are using the overlay upgrade procedure with Postgres as your database and you installed an earlier version of JasperReports Server, you might see an HTTP Status 404 error. The jasperserver-por.log file will show something like:

111

JasperReports Server Installation Guide

ERROR ContextLoader,Thread-1:307 - Context initialization failed org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'proMaintenanceSchedulerTriggers' defined in ServletContext resource [/WEB-INF/ applicationContext-audit.xml]: Cannot resolve reference to bean 'heartbeatTrigger' while setting constructor argument with key [1];

The occurs because if you use the Installer, in the default master properties file we have the user postgres and in context.xml we have the user jasperdb. If this occurs, perform the following procedure: 1. 2. 3. Back up your existing master properties. Change the DB user in the master properties to jasperdb. Run the overlay upgrade.

112