TIBCO JasperReports Server v6.1.0 Release Notes

TIBCO (TM) JasperReports Server (R) 6.1.0 Release


Introduction

JasperReports Server is a high-performance standalone or embeddable Business Intelligence (BI) platform that provides rich reporting and integrated in-memory analysis capabilities.

These release notes describe the installation and available functionality at a high level; for details, please refer to the online help. Please also refer to the documentation, which is available at: http://community.jaspersoft.com/documentation or at <js-install>/docs after installation. In particular, refer to the Installation Guide for instructions about running the installer, creating and updating the database, and deploying the WAR file; refer to the Upgrade Guide for instructions on upgrading from previous versions.

Note: JasperReports Server is governed by a License Agreement, the text of which is found at <js-install>/Jaspersoft-Subscription-Services-Agreement.txt. Please read it before you login to JasperReports Server for the first time. If you installed the server using the installer binary (rather than deploying a WAR file), you have already agreed to this license.


What's New

JasperReports Server 6.1.0 includes these improvements:

  • Dashboard hyperlinking

    In the dashboard designer introduced in 6.0, you can now define hyperlink behavior for a chart dashlet, which lets you specify an internal or external URL to be called when a user  clicks a dashlet.

  • Dashboard HTTP Parameters

    Dashboards created with the Version 6 Dashboard Designer can be called via HTTP, which now includes the ability to pass parameters into a a Dashboard.

  • In the dashboard designer introduced in 6.0, self-hyperlinks are now supported in report dashlets.

  • TIBCO Spotfire 7 Support

    Spotfire Infolinks can be used as a data source in Jaspersoft Studio.

  • Visualize.js

    New enhancements provide control for report:

    • Magnification
    • Save/Save As
    • Sorting of columns in interactive reports
       
  • Support for TIBCO GeoAnalytics Maps

    In this release, you can create reports in Jaspersoft Studio that include map components from GeoAnalytics. Either TIBCO Maps or Google Maps can provide the map image of these multi-layer maps, and paths and markers can be defined using either latitude and longitude or a street address by using geolocation. Note that a separate license is required to access TIBCO's geolocation services.

  • Data Connectivity

    • Support for Query based data source, such as XMLA, JSON, and Remote XML
    • Domains  partially support custom data sources (users can only   view the Display tab in the Domain designer. However users can apply pre-filters and calculated measures using  the Domain XML file)
    • Custom data sources can be included in virtual data sources
    • Custom data source deployment has been simplified, For details, see the JasperReports Server Administrator Guide.
       
  • Documentation Improvements

    In our continuing efforts to improve the security of JasperReports Server, we have reorganized some of our documentation for ease of use. In previous releases, information about securing the application was spread across several documents. In this release, the new security guide describes security concerns and steps you can take to protect your application. Details of data-level security in OLAP remain in that product's user guide.

  • More Powerful Attributes

    A new user interface allows administrators to define attributes easily throughout the server. New permissions on attributes allow administrators to control the visibility and usage of attributes, as well as delegate management to sub-organizations. Attributes are now accessible in Domains and Ad Hoc views so that data access and reports can be easily customized for each user or organization.

  • Diagnostics

    Data/Result Set and Log Capture utilities that are designed to help diagnose problems with the Jaspersoft environment. For more information, see the JasperReports Server Administrator Guide. 

  • Updated Default Theme

    An updated theme for the web UI improves the server's look and feel.

  • Updated version of Groovy

    We have updated the version of one of our third-party components; Groovy is used in Domain definitions. We upgraded our Groovy version from 2.0.1 to 2.4.3.

  • HTML5 Rendering for Fusion components

    Fusion-based charts, maps, and widgets in reports are rendered in HTML5 by default starting in this release; if users access Pro Widgets and Maps using IE8, you should configure the server to use Flash by default, instead. For more information, see the JasperReports Server Administrator Guide.

  • Updated versions of some of the components that are provided in the JasperReports Server installer

    • Apache Tomcat 7.0.59
    • Postgres 9.1.15 (32 or 64 bit)
    • Oracle JDK 1.7.0_75 (32 or 64 bit)
    • JasperReports Server Web Application (WAR) file
       
  • New Platform Support

    JasperReports Server now supports:

    • Java 8 as a JDK
    • Oracle12c as a repository database
    • Oracle RAC as a repository database
    • New Big Data Support
      • MongoDB version 2.6 via TIBCO JDBC driver and native drivers
      • Domains now provide a user interface to create schemas for data stored in
        • MongoDB
        • HortonWorks 2.2, Cloudera 5.2
        • Impala 2.0 (supported through TIBCO JDBC driver or Cloudera drivers)
        • Spark SQL 1.1
        • Amazon Redshift (supported through TIBCO JDBC driver)

Installation Overview

Binary Installer

To install JasperReports Server, you can use the binary installer, which is available for Windows, Linux, and Mac. This installer optionally puts Tomcat, Java, and PostgreSQL onto your system so that JasperReports Server is ready to run.

Download this installer from http://jaspersoft.com/downloads or from the Support site: http://support.jaspersoft.com:

jasperreports-server-6.1.0-<osType>-x64-installer.<ext> (64 bit)

Double-click the installer and accept the default installation type to create a default installation. Select the custom installation type to configure your instance. The installer can also be run from the command line.

For more information on JasperReports Server installation, refer to the Installation Guide, which is found at:

<js-install>/docs/JasperReports-Server-Install-Guide.pdf

War File Distribution ZIP js-install Script Installation

NOTE: You can use the js-install command-line shell scripts if you are installing to the following databases:

  • PostgreSQL
  • MySQL
  • DB2
  • Microsoft SQL Server
  • Oracle

And the following application servers:

  • Tomcat
  • Glassfish
  • JBoss 5
  • JBoss 7

For information on the js-install scripts, see Chapter 5 of the Installation Guide. To run the js-install scripts, download the WAR File Distribution ZIP file from the Jaspersoft Support site at http://support.jaspersoft.com. The file name is:

jasperreports-server-6.1.0-bin.zip

To install, go to the buildomatic folder, create and edit a default_master.properties file, and run js-install.sh/bat:

cd <js-install>/buildomatic
cp sample_conf/<dbType>_master.properties  default_master.properties

edit default_master.properties (with your app server and db properties added)

./js-install.sh  (or js-install.bat)

Then setup increased JAVA_OPT memory options for your application server following instructions from the Install Guide section 6.2.

For example, under Linux with Tomcat:

Add to <tomcat>/bin/setclasspath.sh at the top of the file:

export JAVA_OPTS="$JAVA_OPTS -Xms1024m -Xmx2048m -XX:PermSize=32m -XX:MaxPermSize=512m"
export JAVA_OPTS="$JAVA_OPTS -Xss2m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled"

Next, copy your jasperserver.license to your application server user's home folder:

cp <js-install>/jasperserver.license  <path-to-home-folder>

For information on JAVA_OPTS configuration and license configuration, see the Installation Guide sections 6.2 and 6.3.


Login

To login after installation, use the following URL:

http://<hostname>:8080/jasperserver-pro

During installation, default administrative users are created:

User Password
superuser superuser
jasperadmin jasperadmin

If you install the sample data, sample end-users are also created, including:

User Password
joeuser joeuser
demo demo

CAUTION: For security reasons, always change the default passwords immediately after installing JasperReports Server.


Starting and Stopping

If you installed using the binary installer, refer to this section for information about starting and stopping the server. For other configurations, refer to the Installation Guide.

Windows:

You can start and stop from the Windows menus:

Programs > JasperReports Server 6.1.0 > Start and Stop > Start Service or Stop Service

Linux:

You can start and stop from the command line:

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

Mac OS X:

From Finder, double-click the start, stop, or login apps:

/Applications/jasperreports-server-6.1.0/jasperServerStart.app
/Applications/jasperreports-server-6.0.1/jasperServerStop.app
/Applications/jasperreports-server-6.0.1/jasperServerLogin.app

Alternatively, you can start/stop from the OS X command line:

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

Upgrade Notes

Introduction

You can upgrade directly to 6.1.0 if your instance is one of the following:

v3 v4 v5 v6
3.7 4.0 5.0 6.0.0
3.7.1 4.0.1 5.0.1 6.0.1
4.1 5.1
4.2 5.2
4.2.1 5.5
4.5 5.6
4.5.1 5.6.1
4.7
4.7.1

To upgrade, start with the WAR File Distribution ZIP:

jasperreports-server-6.1.0-bin.zip

It can be downloaded from the Jaspersoft Support site at http://support.jaspersoft.com.

The recommended upgrade procedures are fully described in the Upgrade Guide chapters 2, 3, and 4.

Note: If you are upgrading from JasperReports Server version 4.5 (or earlier) the upgrade involves substantial changes that may require you to plan and prepare beforehand. Please refer to Upgrade Guide Appendix A for advice regarding these important considerations. Also, see section 6.6 of these Release Notes.

Database Changes

There are jasperserver repository database changes between 6.0.x and 6.1.x.

Upgrade to 6.1.0 (Overlay Upgrade) (Tomcat Only)

The 5.1 release added an improved package for upgrading between versions called the Overlay Upgrade.

This package supports a new procedure for upgrading from JasperReports Server 4.0 and above. It can preserve and give execution-time feedback on modified files and customizations found in your JasperReports Server instance. This allows the upgrade to preserve your customizations and gives you visibility into which files changed.

This new procedure also supports rollback to put your original web application instance back in place.

This package is only implemented and certified to work with the Tomcat application server. All certified repository databases are supported.

Start by downloading the Overlay Upgrade package from http://support.jaspersoft.com. The package name is:

jasperreports-server-overlay-upgrade-6.1.0.zip

To start your overlay upgrade, unzip the package and open a command shell to the root of the package. Make sure to stop your Tomcat instance. Then enter:

overlay install    (this initiates the upgrade operation)

You are prompted for a working folder (accept the default)

It is assumed that you have a default_master.properties file from your original JasperReports Server installation. You are prompted for the path to this file. Enter the path.

The overlay upgrade can now execute.

Once the overlay upgrade is complete (and you have resolved any file conflicts), restart Tomcat.

Additional Supported Commands:

overlay help       (this displays all available commands)

For information on the overlay upgrade functionality, see the JasperReports Server Upgrade Guide Chapter 2.

Upgrade from 6.0.x to 6.1.0

To upgrade from 6.0.x, the recommended procedure is described in the Upgrade Guide Chapter 3. This procedure is run from the command line. Here is a summary of the steps used for this upgrade:

cd <unpacked-dir>/buildomatic
cp sample_conf/<dbType>_master.properties  default_master.properties

edit default_master.properties (add your app server and db properties)

./js-upgrade-samedb.sh   (or js-upgrade-samedb.bat)

Upgrade from Older Versions

This upgrade procedure lets you upgrade from any of the JasperReports Server versions listed in this section's introduction (starting with version 3.7 through 6.0.x).

The recommended procedure is described in the Upgrade Guide Chapter 3. This procedure is run from the command line. Here is a summary of the steps used for this upgrade procedure:

Export your existing JasperReports Server repository data using the buildomatic/js-export.(sh|bat) command. For example:

./js-export.sh --everything --output-zip my-export.zip

Or export directly from the UI as of version 5.0 and later.

Then:

cd <unpacked-dir>/buildomatic
cp sample_conf/<dbType>_master.properties  default_master.properties

Edit default_master.properties (add your app server and db properties)

./js-upgrade-newdb.sh  <path>/my-export.zip
 
or
 
js-upgrade-newdb.bat <path>/my-export.zip

Upgrade from Community Project

If your current instance is the Community version, you can follow the Upgrade Guide steps in Chapter 6 to upgrade to the Commercial version.

Important Upgrade Information

Changes in the 6.1.0 Releases

The new look-and-feel of JasperReports Server required several structural several changes to the structure of the themes. If you have customized your theme, you must re-apply those customizations to a new theme object. For more information, refer to the Jasperreports Server Upgrade Guide.

Changes in the 6.0.x Releases

Starting in this release, the server now incorporates a more recent version of the underlying Spring Security framework. We now use Spring Security 3. If you are upgrading from a previous version of JasperReports Server, you may need to take additional steps to accommodate the file structure of the new version of Spring. This is particularly the case if you have custom LDAP or SSO configured for the server. For more information, refer to the JasperReports Server External Authentication Guide.

Changes in the 5.6.0 Release

The 5.6.0 version included two changes that may require you to take additional steps during upgrade:

  1. JDBC Drivers: The 5.6.0 version did not include JDBC drivers for some of the typical commercial databases (Oracle, MS SQL Server, or DB2). In 5.6.1 and forward, we have included drivers for these data sources; the manual steps required to add these drivers are no longer necessary. For more information, see the documentation; in particular:
    • Information on working with drivers during installation is in the JasperReports Server Installation Guide.
    • Information on working with drivers during upgrade is in the JasperReports Server Upgrade Guide.
    • Information on working with drivers in the web UI is in the JasperReports Server Administrator Guide.
  2. * Changes to OLAP engine: Due to a change between versions of the OLAP engine, if you use Jaspersoft OLAP's XML/A functionality to connect to a remote JasperReports Servers XML/A sources, you must take additional steps to complete your upgrade to 5.6.x. For information, see Known Issue 35985 (in these release notes).

Additional Information on Planning for Upgrade

For additional information on planning for your upgrade please see Appendix A "Planning Your Upgrade" in the JasperReports Server Upgrade Guide.


Security Fixes

  • 36569: SECURITY - CVE-2014-0050.
    TIBCO Jaspersoft addressed a vulnerability in the Apache Commons FileUpload component. Previously, the server was potentially vulnerable to specially crafted Content-type headers that can allow Denial of Service attacks. In release 5.6.0, TIBCO Jaspersoft upgraded to Apache Commons FileUpload component version 1.3.1 which addresses this security issue. For more information on the underlying issue, see: http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2014-0050

Known Issues

  • 17824: While Fusion Charts support annotations, JasperReports Server and Jaspersoft Studio don't support them. Annotations cannot be used in Pro Charts. We plan to address this issue in a subsequent release.

  • 21798: Performance in Internet Explorer. When JasperReports Server is accessed through Microsoft Internet Explorer 8, performance may be impaired. We recommends version 9 or 10 of Internet Explorer. Internet Explorer users should also note that we no longer certify IE7.

  • 30018: When an XML/A provider returns data to the Ad Hoc Editor, JasperReports Server sometimes must convert the datatype to string. For example, an XML/A provider may return data of type currency; in an Ad Hoc view, such currency data is a string that displays as a symbol (such as $) and a number. When such an XML/A-based Ad Hoc view is saved as a report, its datatypes are converted again. JasperReports Server attempts to convert the data to their original types, but in some cases, such as currency, no such type is available, and so currency data is converted to type double. In a report created from an Ad Hoc view, XML/A data that was returned with datatype currency is displayed as a number; the currency symbol is omitted. We plan to address this issue in a subsequent release.

  • 31955: In Pro Charts (based on Fusion), Gantt charts do not support HTML5 output format. We find that this limitation originates in Fusion, and so have no plans to resolve it. Fusion may address this issue in a subsequent release.

  • 32159: When the 64-bit JasperReports Server binary installer is run in some versions of Mac OSX (including Mac OSX 10.8.3), and you select the option to install the bundled PostgreSQL, an error appears if PostgreSQL 9.1 is already installed. The message indicates that the process couldn't create a shared memory segment, and directs you to further information in the PostgreSQL documentation. For example, see http://www.postgresql.org/docs/9.1/static/kernel-resources.html, which describes a workaround for the problem. We have determined that this workaround can resolve the issue in the JasperReports Server installer. Since the problem originates in the PostgreSQL installer, we have no current plans for its resolution.

  • 32168: Though we do not strictly support the practice, in previous versions of JasperReports Server, it was possible to create a clone install in JBoss by copying an existing JasperReports Server WAR file and deploying it to a new JBoss instance. With 5.1, Jaspersoft supports JBoss AS7/EAP6, but has uncovered issues with clone installs. For more information, refer to http://tinyurl.com/cv6ta2l.
  • 33003: Export catalogs created through the web UI in JasperReports Server version 5.1.x contain incorrect metadata. When these catalogs are imported into JasperReports Server version 5.2, the objects they contain are created in the wrong location in the repository. To work around the problem, you must edit the catalog manually to edit a single line in a text file before importing it:

    1. Navigate the export catalog and locate the index.xml file.

    2. Open the index.xml file in a text editor and locate this text near the top of the file:

      <?xml version="1.0" encoding="UTF-8"?>
          <export>
              <property name="pathProcessorId" value="zip"/>
              <property name="jsVersion" value="5.1.0 CE"/>
              <module id="repositoryResources">
                  <folder>/public</folder>
              </module>
              <module id="reportJobs"/>
          </export>
    3. Update the jsVersion property to correctly identify the version of JasperReports Server that created the catalog.

      For example, change:

      <property name="jsVersion" value="5.1.0 CE"/>

      To:

      <property name="jsVersion" value="5.1.0 PRO"/>
    4. Save the file.

    5. Import the file into JasperReports Server.

  • 35986 - If you use Jaspersoft OLAP's (R) XML/A functionality to connect to a remote JasperReports Server's XML/A sources, you must take additional steps to complete your upgrade. You must redefine your XML/A connections to specify the connection string in a new way. For example, in previous versions, the Foodmart XML/A connection specified:

    Provider=Mondrian;DataSource=Foodmart

    In the new version, the DataSource portion of the connection string is always JRS when the remote provider is JasperReports Server. For example:

    Provider=Mondrian;DataSource=JRS

  • 40543: Jaspersoft uncovered a number of issues while testing this release when deployed in Glassfish 3.1. They prevent us from supporting that specific version of Glassfish with this release. We found that the issue originates in the Spring framework, and so we have no plans to resolve it. Pivotal may address this issue in a subsequent release. For more information, please see: https://jira.spring.io/browse/SPR-11389.

Release Distributions

Installer Distributions

Installer General Notes

The installers contain all components needed to run the JasperReports Server web application. Bundled components are:

  • Apache Tomcat 7.0.59
  • Postgres 9.3.6 (32 or 64 bit)
  • Oracle JDK 1.7.0_25 (32 or 64 bit)
  • JasperReports Server Web Application (WAR) file

Installer Supported Operating Systems (32 bit and 64 bit)

  • Linux Installer

    • Red Hat Enterprise Linux 5.4, 5.5, 5.6, 6.1, 6.4
    • Novell SUSE Linux Enterprise 10.3, 11.1
    • Ubuntu 10, 11, 12, and 14
    • Debian 5.0 and 6.0
    • Fedora 19 and 20
    • CentOS 5.6 and 6.1
  • Windows Installer

    • Windows 7 (SP1) and 8.1
  • Mac OSX Installer

    Note: OSX 32 bit is no longer supported as of version 5.5.

    • Snow Leopard (10.6)
    • Lion (10.7)
    • Mountain Lion (10.8 and 10.9)
    • Yosemite (10.10.1)

Installer Supported Application Configurations

  • Bundled Tomcat with Bundled PostgreSQL
  • Bundled Tomcat with Existing PostgreSQL
  • Existing Tomcat with Bundled PostgreSQL
  • Existing Tomcat with Existing PostgreSQL

WAR File Binary Distribution:

The War File Binary Distribution zip currently contains sample configurations and repository database setup scripts that support the following applications (file name: jasperreports-server-<ver>-bin.zip):

Application servers:

  • Apache Tomcat 5.5, 6.0, and 7.0 (we recommend 7.0.19 and higher); Tomcat 6.0 is also supported with the Linux advanced packaging tool (such as apt-get and yum)
  • SpringSource tc Server 2.0.x bundle (6.0.x runtime) and 2.1.5
  • GlassFish 2.1 and 3.0
  • JBoss 5.1, 7.1, and JBoss EAP 6.2
  • WebLogic 10.3.6, 12
  • WebSphere 7.0, 8.0

Database servers:

  • PostgreSQL 9.0, 9.1, 9.2, and 9.3
  • MySQL 5.1, 5.5, 5.6
  • IBM DB2 9.7, 10.1, 10.5
  • Microsoft SQL Server 2005, 2008 R2, 2012, and 2014
  • Oracle 11g R1, 11g R2, 12c

Java Virtual Machines:

  • Oracle JDK 1.6, 1.7, and 1.8
  • OpenJDK 1.6; specifically:
    • OpenJDK 1.6.0_20
    • OpenJDK RunTime Environment (IcedTea6 1.9.7)
    • OpenJDK 64-Bit Server VM (build 19.0-b09, mixed mode)
  • OpenJDK 1.7

For more information, refer to the Jaspersoft Platform Support document, which is available on the Support Portal.


End of Support Notices

TIBCO Jaspersoft is in the process of ending support for several technologies:

  1. JasperReports Server no longer supports JDK 1.5.

  2. We have deprecated our Open Flash functionality in favor of HTML5 solutions. In particular, the Flash samples that shipped with previous versions of the server are no longer provided. Also note that the Flash export option has been removed from the report viewer. If you want to re-enable this option, you can uncomment the exporter in a configuration file.

    To do so, open the WEB-INF/flows/viewReportBeans.xml file and uncomment this line:

    <entry key="swf" value-ref="swfExporterConfiguration"/>
  3. With the completion of the v2 REST API, we announced the deprecation of the original REST API and the end-of-life of the SOAP services. While these services will remain available in the server for the time being, we recommend that you migrate your integration to the latest API available: Jaspersoft v2 REST API.

  4. For Mac OSX, we no longer support:

    • The 32 bit version of Apple OSX
    • Apple OSX 10.5
  5. With the general availability of the commercial edition of Jaspersoft Studio, we announced that iReport is now in maintenance mode. We recommend that you migrate to Jaspersoft Studio, which offers improvements beyond what is available in iReport.

  6. With the addition of more advanced interactive behavior in the report viewer, JasperReports Server no longer supports interactivity in the xhtml report exporter. If you want your reports to be interactive when viewed in the server, you must use the default report exporter (html2). For more information, see the JasperReports Server Administrator Guide.

  7. In April 2014, Microsoft ended support for its Windows XP operating system. For more information, see: http://www.microsoft.com/windows/en-us/xp/end-of-xp-support.aspx

  8. In January 12, 2016, Microsoft will end support for Internet Explorer version 8. Also note that this is the last release of JasperReport Server that supports Internet Explorer 7.

  9. Support for some versions of our Jaspersoft BI Products, including JasperReports, JasperReports Server, and iReport, has ended:

    • Support for version 4.5.x ended on July 2, 2014.
    • Support for version 4.7.x ended on November 12, 2014.
    • Support for version 5.0.0 ended on April 29, 2015.
  10. Version 6.0.0 is the last version that support Spring Security 2.x. All releases after Version 6.0 will support Spring 3.x and may require updates to any authentication integration code that was written to work with prior JasperReport Server releases.


Evaluation License

The installer includes several 30 day evaluation licenses that allow you to run various editions of JasperReports Server.

When the evaluation period expires, you must replace the evaluation license with a commercial license to enable the software. Please refer to the JasperReports Server Installation Guide for information on replacing the license.

If you don't already have a commercial license, you can obtain one by contacting your Sales representative.

During your evaluation, we invite you to use Evaluation Central to learn about our products: http://www.jaspersoft.com/getting-started

We also offer a guided evaluation experience: https://www.jaspersoft.com/get-started-evaluating


Part Number: 0515-JSP61-30

Copyright (C) 2005-2015, TIBCO Software Inc.
All rights reserved. Printed in the U.S.A. Jaspersoft, the Jaspersoft logo, Jaspersoft iReport Designer, Jaspersoft Studio, JasperReports Library, JasperReports Server, Jaspersoft OLAP, and Jaspersoft ETL are trademarks and/or registered trademarks of TIBCO Software Inc. 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.

Feedback