Some of the new and enhanced features in JasperReports Server 4.7, 5.0, and 5.6 can affect your deployment and you should plan your upgrade accordingly. Prior to upgrading to you should make sure to:
| • | Review this information carefully and determine how the changes described affect your deployment. |
| • | Make sure to back up your current JasperReports Server installation and repository before upgrading. |
The versions and their affected functionality are as follows:
| • | Changes in 5.6 affect commercial JDBC drivers as well as XML/A connections. |
| • | Changes in 5.0 affect XML/A connections and deployments with custom settings. |
| • | Changes in 4.7 affect deployments with Ad Hoc reports and/or theme customizations. In addition, if you enable the data snapshot functionality added in 4.7, size requirements for your repository may increase. |
Changes are cumulative, so review all topics that affect you. For example, if you are upgrading from 4.7 to 5.6, you may be affected by changes in 5.6 and 5.0.
This section describes only those changes that can significantly impact your existing deployment. 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:
| • | Changes in 5.6.1 That May Affect Your Upgrade |
| • | Changes in 5.6 That May Affect Your Upgrade |
| • | Changes in 5.0 That May Affect Your Upgrade |
| • | Changes in 4.7 That May Affect Your Upgrade |
Changes in 5.6.1 That May Affect Your Upgrade
In 5.6.1, Jaspersoft added TIBCO JDBC drivers for the following commercial databases:
| • | Oracle |
| • | SQL Server |
| • | DB2 |
| • | Hive — available as a data source only; cannot be used for the JasperReports Server repository database. |
The new drivers have the following impact:
| • | If you are upgrading and want to use your current driver for the repository, you must copy the driver to the correct location and modify default_master.properties for the driver you choose. See the section on your upgrade procedure for more information. |
| • | If you are using WebLogic or WebSphere and want to use a TIBCO driver, you need to set up the driver in your application server console. See the JasperReports Server Installation Guide or the JasperReports Server Administrator Guide for more information. |
| • | For supported Hive platforms other than Impala and Cloudera 5, you must use the TIBCO JDBC driver. |
Changes in 5.6 That May Affect Your Upgrade
The following changes in 5.6 and newer can significantly affect your deployment:
| • | Removal of commercial JDBC drivers: if you are using a commercial JDBC driver, you will need to copy it to the correct location in your upgraded JasperReports Server. |
| • | Changes to OLAP engine: Due to change between version of the OLAP engine, if you use Jaspersoft OLAP’s XML/A functionality to connect to a remote JasperReports Server’s XML/A sources, you must take additional steps to complete your upgrade to 5.6. |
Removal of Commercial JDBC Drivers
The following commercial database drivers were removed from the JasperReports Server 5.6 package: Oracle, SQL Server, or DB2. You will need to obtain a JDBC driver before running the upgrade steps. In this case, for Oracle, since you most likely have an Oracle JDBC driver in your existing JasperReports Server instance, it can be simplest to copy it from that location:
Copy from: <js-install-existing>/buildomatic/conf_source/db/oracle/jdbc/<driver-name>.jar
Copy to: <js-install-5.6>/buildomatic/conf_source/db/oracle/jdbc
Changes to OLAP Engine
If you use Jaspersoft OLAP’s XML/A functionality to connect to a remote JasperReports Server’s XML/A sources, you must take additional steps to complete your upgrade to 5.6. This is due to a change between versions of the OLAP engine.
Once the new version of JasperReports Server is installed and running, locate all the XML/A connections that point to a remote JasperReports Server instance. Then, edit the DataSource field to specify JRS as the DataSource portion of its value.
For example, in previous versions, the Foodmart XML/A connection specified:
Provider=Mondrian;DataSource=Foodmart;
During upgrade, this connection must be changed to:
Provider=Mondrian;DataSource=JR
Note that for 5.6, the trailing semicolon should be removed (the older 5.5 syntax includes a semicolon at the end).
For more information about creating and editing XML/A connections, refer to the Jaspersoft OLAP User Guide.
Note that if your instance hosts multiple organizations, XML/A connections will fail for superuser. This limitation applies exclusively to the superuser account. To test connections in servers that host multiple organizations, Jaspersoft recommends that you log in as jasperadmin or another administrative account that is not superuser.
One reason you might have XML/A connections to remote instances of JasperReports Server is to create a load-balanced Jaspersoft OLAP environment. For more information, refer to the Jaspersoft OLAP Ultimate Guide.
Changes in 5.0 That May Affect Your Upgrade
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 Upgrading Preserving Custom Settings for more information about this feature. |
| • | XML/A Connections to Servers with Multiple Organizations: If you use Jaspersoft OLAP as an XML/A provider for remote clients, and the server hosts cubes for multiple organizations, you must take additional steps during upgrade. See XML/A Connections to Servers with Multiple Organizations for more information about this procedure. |
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 script will automatically preserve any custom global properties you have set, whereas the js-upgrade-newdb script will not preserve your custom global properties.
XML/A Connections to Servers with Multiple Organizations
Unless your JasperReports Server instance includes both Jaspersoft OLAP XML/A connections and multiple organizations, you can skip this section.
If you use Jaspersoft OLAP as an XML/A provider for remote clients, and the server hosts cubes for multiple organizations, you must take additional steps during upgrade.
In previous versions, an XML/A connection pointing to another JasperReports Server that hosted multiple organizations could pass an organization’s ID to the remote server as an argument in the Data Source field. In this release, this configuration is no longer supported. If your XML/A connections pass organization IDs using the tenantID argument in the Data Source field, you must edit the XML/A connections and remove the tenantID argument. You must still pass a user’s organization along with the user name and password when connecting in this configuration; the user’s organization determines the cube that is queried.
Note that, if you connect to a specific organization's XML/A source in a remote server as superuser, you must still pass the tenantID argument in the XML/A connection’s Data Source field. However, Jaspersoft recommends that you instead connect as jasperadmin or as a non-administrative user of the specific organization. For more information, refer to the Jaspersoft OLAP User Guide.
Changes in 4.7 That May Affect Your Upgrade
The following changes in 4.7 can affect your deployment:
| • | Ad Hoc Reports: The workflow of the Ad Hoc Editor has been modified to distinguish between Ad Hoc views, which allow you to interact with the data and perform data analysis, and reports generated from Ad Hoc views, which allow you to view the data and generate reports. In addition, you can create multiple reports from a single Ad Hoc view; you can then modify the Ad Hoc view and see your changes reflected in dependent reports. This upgrade makes fundamental changes to the architecture of Ad Hoc objects, and migrates all existing Ad Hoc reports to a new Ad Hoc view format. You may encounter the following when you migrate an Ad Hoc report to an Ad Hoc view: |
| • | (Affects all deployments with Ad Hoc reports) To ensure that your Ad Hoc reports continue to appear in any dashboards where they are used, the Ad Hoc migration process creates two objects for each Ad Hoc report: an Ad Hoc view that contains your data analysis and a report that refers to the data and contains any additional formatting that has been applied using iReport or Jaspersoft Studio. This means that the upgrade will double the number of Ad Hoc-related objects in your JasperReports repository. For example, if you have 10 Ad Hoc reports prior to the 4.7 upgrade, after migration you will have 20 objects — 10 Ad Hoc views and 10 related reports. Unwanted reports can be manually deleted unless they are used in dashboards. |
| • | (Affects tabular Ad Hoc Reports) The widths of columns in a tabular report are not perservered. Use the interactive report viewer to reset the column widths and save the report again. |
| • | (Affects Ad Hoc reports modified in iReport or Jaspersoft Studio) Modifications made to an Ad Hoc report in iReport or Jaspersoft Studio are not persevered. The JRXML of the original Ad Hoc report is attached to the converted report for reference. Reports created directly in iReport or Jaspersoft Studio are not affected. |
| • | (Affects OLAP Ad Hoc reports against XML/A clients) Ad Hoc OLAP reports against XML/A clients must be migrated manually using a menu selection. |
| • | (Affects some Ad Hoc reports with customizations) Some reports with customizations may not migrate. |
See Migrating Ad Hoc Reports to Ad Hoc Views for more information.
| • | 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. However, existing themes will have to be redesigned in order to work in 4.7. See Upgrading Themes in 4.7 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 for more information on data snapshots. |
Migrating Ad Hoc Reports to Ad Hoc Views
The workflow of the Ad Hoc Editor has been modified to distinguish between Ad Hoc views and the reports generated from them. Jaspersoft has deprecated the ambiguous Ad Hoc report resource in favor of an Ad Hoc view resource equivalent to an interactive data source. Ad Hoc views may only be opened in the Ad Hoc Editor, and reports created from Ad Hoc views open in the interactive report viewer.
You may see the following problems when you upgrade Ad Hoc reports:
| • | Ad Hoc reports migrate, but have formatting problems. |
| • | Changes made to an Ad Hoc Report in iReport or Jaspersoft Studio are not persevered. |
| • | Ad Hoc OLAP reports against XML/A clients must be migrated manually using a menu selection. |
| • | Migration fails for some Ad Hoc reports. You can locate problematic reports in the repository using a simple search. |
Changes to Ad Hoc
“Comparison of Ad Hoc Reports and Ad Hoc Views” summarizes the differences between Ad Hoc reports and Ad Hoc views.
Comparison of Ad Hoc Reports and Ad Hoc Views
Ad Hoc 4.5.1 and earlier
Ad Hoc in 4.7
Ad Hoc report can be opened in interactive viewer.
Ad Hoc view can be opened in display mode in Ad Hoc Editor.
Ad Hoc report can be opened in interactive viewer, iReport, and Jaspersoft Studio.
Reports created from Ad Hoc views can be opened in interactive viewer, iReport, and Jaspersoft Studio.
In order to Export the results, user must open report in interactive viewer, iReport, or Jaspersoft Studio.
User can Export results directly from Ad Hoc Editor.
Ad Hoc reports can be directly included in dashboards.
Reports created from Ad Hoc views can be included in dashboards.
Results of Ad Hoc analysis tied to a single report.
Multiple reports can be created from a single Ad Hoc view.
Ad Hoc report can be directly modified in iReport or Jaspersoft Studio.
Reports created from an Ad Hoc view can be modified in iReport or Jaspersoft Studio.
A single view can be presented in multiple ways. For example, a chart in a dashboard and a detailed PDF report can be created from the same Ad Hoc view.
Modifications made in iReport or Jaspersoft Studio are lost when Ad Hoc report is reopened in Ad Hoc Editor.
When an Ad Hoc view is updated in Ad Hoc Editor, changes are reflected in reports created from that view. However, not all changes can be supported in all reports. A warning is displayed whenever changes are made to an Ad Hoc view with dependent reports.
Table components in reports created from Ad Hoc views are interactive. Future enhancements will extend Ad Hoc interactivity.
Ad Hoc reports prior to 4.5.0 could apply Ad Hoc styles.
As of 4.5.0, Ad Hoc styles are no longer supported.
Incompatible with future versions of JasperReports Server.
Updated architecture supports future feature enhancements to Ad Hoc.
Output of Migration Process
When you upgrade, each Ad Hoc report from 4.5.1 or earlier is transformed to a pair of objects as follows:
| • | Ad Hoc view: An Ad Hoc view since 5.6 and newer provides functionality corresponding to an Ad Hoc report opened in Design Mode in earlier versions. You can think of an Ad Hoc view as a window into a data set, along with tools that allow you to perform data analysis, such as determining the main layout and selecting fields and filters. The name of the Ad Hoc view is the name of the Ad Hoc report with AdHocDataView appended: |
| • | filename: <filename>_AdhocDataView — for example, Western_Region_Sales_AdhocDataView |
| • | label: <report_name> Ad Hoc view — for example, Western Region Sales Ad Hoc View |
| • | description: Ad Hoc view created from the <report_name> report — for example, Ad Hoc view created from the Western Region Sales report |
| • | Report: Contains any modifications made in the interactive report viewer. The path, name in the repository, and description of the upgraded report are identical to those of the Ad Hoc report prior to upgrade. This ensures the report still appears wherever it is used, such as dashboards, job schedules, or reference links from JasperReports Server or an external system. If you do not need this report, it can be manually deleted from the repository. |
| • | filename: <filename> — for example, Western_Region_Sales |
| • | label: <report_name> — for example, Western Region Sales |
| • | description: <description> — for example, This report shows sales numbers for the Western Region grouped by product class, store location and month |
Ad Hoc Migration Process
The JasperReports Server upgrade includes a migration script that performs the conversion from Ad Hoc reports to Ad Hoc views and their associated reports.
| | Report migration information is written to the log. You can get more information about the results of migration by turning on debug mode; this will impact the performance of the upgrade process. |
| • | If you upgrade your repository by running the upgrade scripts on the existing repository database, the script to migrate Ad Hoc reports runs when the new JasperReports Server starts for the first time. Because the conversion process is part of JasperReports Server initialization, it may take longer than usual for the JasperReports Server web application to accept logins. The time required for conversion depends on the speed of your system and the number of Ad Hoc reports that need to be converted. |
You can observe the progress of the report conversion process in the log file:
<js-install>/buildomatic/logs/js-upgrade-<date>-<number>.log
| • | If you start with a clean 4.7 or newer installation and import repository data from your previous JasperReports Server installation, the script to migrate Ad Hoc reports runs as part of the import process. If some reports fail to migrate, the script also runs during server initialization as described above. Running the script a second time migrates reports that depend on environment variables or services that are not configured during import. For example, Ad Hoc reports that use a JNDI data source configured inside the application server cannot be migrated while the application server is turned off for import. |
Issues in Migrated Reports
Some Ad Hoc reports may migrate automatically but exhibit formatting issues or other problems. These include:
| • | Ad Hoc styles: Ad Hoc styles applied in JasperReports Server 4.5.0 or earlier are not perservered. |
| • | Table columns: The widths of columns in an Ad Hoc table report are not perservered in the associated report. Use the interactive viewer to reset the column widths and save the report again. |
| • | Modifications in iReport or Jaspersoft Studio: Ad Hoc reports that have been modified in iReport or Jaspersoft Studio should be accessible in 4.7 and newer but will lose the modifications. Examples of such reports include Ad Hoc reports that have been edited to resize a column, apply a style, or add a logo, as well as Ad Hoc reports that have had custom filters, custom multi-level sorting, fusion charts, or input controls added in iReport or Jaspersoft Studio. |
Working with Reports Modified in iReport or Jaspersoft Studio
During migration, the pre-4.7 JRXML is attached to the new upgraded report as a local resource. This JRXML, named oldAdhocJRXML, can be opened from iReport or Jaspersoft Studio for reference and compared with the new report. This can help you see report content that did not migrate, and help you understand how best to manually correct the automatically-generated report. Note that the attached JRXML is not used during upgrade in any way.
To better understand the changes that you made in iReport or Jaspersoft Studio, you can work with the Ad Hoc report in your current (pre-upgrade) version of JasperReports Server. You can save a copy of the Ad Hoc report, open this copy in the Ad Hoc editor, and then save it. This copy should contain information similar to the Ad Hoc view you get during migration. You can then compare the JRXML of the copy with the JRXML of the modified report.
Unsuccessful Migration
Ad Hoc reports that did not migrate successfully show up in the repository with the old Ad Hoc Report type. You can locate these reports using the log or via a special search in the repository. Reports which may not migrate automatically include:
| • | Ad Hoc OLAP reports against XML/A clients must be manually migrated after the server has been upgraded and has been successfully restarted. This does not affect reports against Mondrian clients. |
| • | Ad Hoc reports that did not work correctly in the existing version of JasperReports Server will not migrate. To mitigate this, you need to modify the report in your current version and ensure that it is working correctly prior to migrating it. |
| • | Ad Hoc reports with a custom data source or other custom components may not migrate successfully. |
Finding Ad Hoc Reports Using the Log
The auto-upgrade script creates an output log that captures standard output and error output. The output log file is located here:
<js-install>/buildomatic/logs/js-upgrade-<date>-<number>.log
The migration process writes the following information to the log:
| • | If migration is successful for all Ad Hoc reports, you will see a message such as the following: |
Upgrade process for AdhocReportUnit objects completed successfully.
| • | If some reports did not migrate successfully, you will see an error such as the following: |
Upgrade process for AdhocReportUnit objects completed. There are Y objects of X for which there were some errors during the conversion. Switch on debug for more information.
A stack trace is generated for each report that cannot be migrated:
Error converting AdhocReportUnit (URL=PATH_TO_ADHOC_REPORT_UNIT) to AdhocDataView + ReportUnit
| • | For Ad Hoc OLAP reports against XML/A clients, conversion is skipped. You will see a message such as the following: |
Current AdhocReportUnit cannot be converted during upgrade process because it has XML/A data source. Conversion skipped. Refer to the documentation for details.
See Migrating Ad Hoc OLAP Reports Against XML/A Clients for information on how to migrate these reports manually.
Finding Ad Hoc Reports in the Repository
Reports that did not migrate successfully show up in the upgraded repository with the old Ad Hoc report type. A special search allows you to locate these reports:
| 1. | Select View > Search Results. |
| 2. | In the Filters section at the left, click More choices... (under All types), then click Deprecated Reports. You will see all the Ad Hoc reports that you have permission to view. |
Working with Scheduled Reports
When migration fails for an Ad Hoc report with a scheduled run, the schedule for the report is perservered. At the scheduled runtime, JasperReports Server detects that the report is in the old Ad Hoc report format and does not attempt to run the report. Instead the scheduler writes an error to the log and also sends a notification message, which can be accessed by selecting
View > Messages from the menu.
Working with Reports That Fail to Migrate
When a report fails to migrate, the first thing to do is to open it in the previous version of JasperReports Server. In most cases, investigation shows that reports that fail to migrate do not work in the previous version.
Remember that reports that worked at one time can cease to work when the data source they use changes in some way. For example, if a report has not been used for some time, a schema change such as an updated column name may not be reflected in the report.
You can simplify the upgrade process and reduce the time it takes to migrate your Ad Hoc Reports by deleting unused Ad Hoc reports from your repository prior to upgrade. If auditing is enabled in your current, pre-4.7 version of JasperReports Server, you can use the audit data to locate Ad Hoc reports that have not been accessed for a specified amount of time. You can then delete the reports you no longer want. If desired, you can export each unwanted report individually prior to deletion. See the JasperReports Server Administrator Guide for more information about auditing and about import/export.
Migrating Ad Hoc OLAP Reports Against XML/A Clients
Ad Hoc OLAP reports can only be migrated when the server is running and able to respond to requests from the XML/A data source, which means they cannot be migrated during upgrade. They can be migrated manually as follows:
| 1. | Locate the Ad Hoc OLAP report you want to migrate in the repository. |
| 2. | Right-click the report name and select Migrate report. |
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.
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. “Banner and Toolbar Settings” shows the elements you need to modify and their default locations. The default values are for these elements are in the default.css file.
Element
Classname and Modification
File
Notes
Banner
.banner
Give custom value to height.
containers.css
Default value:
height:26px
Banner Logo
#logo
Give custom values to height and width that match the dimensions of your logo.
theme.css
Default values:
height: 20px
width: 115px
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
Banner
Main Navigation
.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.
containers.css
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.
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
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 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.
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
.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
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.
theme.css
Default value:
line-height: 9px
Banner
Search container
#globalSearch.searchLockup
Set margin-top to desired value that will vertically center it within the banner.
controls.css
Default value:
margin-top:3px
Body
#frame
Set a custom top value that positions the body of the application below the banner.
containers.css
Default value:
top: 28px
This value needs to be greater than the value you apply to the height of .banner.
Toolbar
.toolbar
Set custom height value that will fit your capsule buttons.
containers.css
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.
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. IE-specific 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 *
“Changes to Implementation for IE Style Rules” shows an example of an IE7 style rule that has been combined into the base style rules in 4.7 and newer.
Changes to Implementation for IE Style Rules
IE overrides (4.5.1 and earlier)
lists.css (4.5.1 and earlier)
lists.css (4.7)
.stepIndicator .icon {
*top: 2px;
}
.stepIndicator .icon {
margin: 0;
top: 1px;
margin-right: 3px;
}
.stepIndicator .icon {
position: relative;
margin: 0px;
top: 1px;
*top: 2px; * IE7
margin-right: 3px;
}
Images in JasperReports Server 4.7
Images for navigation, buttons, and backgrounds in the default theme have changed in version 4.7. 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.
“New Images in 4.7 Default Theme” lists the images that have been added in the 4.7 default theme.
New Images in 4.7 Default Theme
Image
Usage
Notes
banner_bkgd.png
Background gradient image for application banner
column_header_bkgd.png
Background gradient image for .header elements in columns and dialogs
Replaces panel_dialog_header_sprite.png image used for dialog box headers in 4.5.1.
inner_pagination_sprite.png
Pagination icons (next, previous, etc) for dashboard report widgets
spacer.gif
Icon that appears in the column header of spacer columns in Ad Hoc Editor
viewer_toolbar_buttons_sprite.png
Button icons for the Ad Hoc Editor toolbar
“Modified Images in 4.7 Default Theme” lists the images that have been modified for the 5.6 and newer default theme.
Modified Images in 4.7 Default Theme
Image
Usage
Notes
adhoc_toolbar_buttons_sprite.png
Button icons for the Ad Hoc Editor toolbar
Some icons are new. All icons have new shadow effect.
button_action_primary_sprite.png
Background gradient images for the three states of .action.primary buttons
Removed rounded corners. Colors were adjusted.
button_action_sprite.png
Background gradient image for the up, over, and pressed states of action buttons
Removed rounded corners. Colors were adjusted.
button_action_square_icons_sprite.png
Button icons for the .action.square buttons
All icons have new shadow effect.
button_capsule_sprite.png
Background images with rounded corners for capsule buttons
Rounded corners have a smaller radius. Colors adjusted. Buttons are shorter in height.
button_options_sprite.png
Background images for the up, over, and pressed states of options buttons
Removed rounded corners. Added a shadow-only image for the pressed state.
disclosure_indicators_sprite.png
Small icons that disclose functionality in various parts of the application (within buttons, menus, lists, and forms)
Shadow effect added to icons for .button.capsule.indicator.
home_bkgd.png
Large background image on home page
Image refactored.
home_icons_sprite.png
Large icons for .action.jumbo button on home and admin home pages
Icons for View Reports and Create Ad Hoc View refactored.
input_bkgd.png
Top inner shadow background image for text inputs
Shadow lightened. Image height changed from 2px tall to 3px tall.
login_welcome_bkgd.jpg
Main image on login page of pro edition
Image refactored.
login_welcome_ce_bkgd.jpg
Main image on login page of community edition
Image refactored.
logo.png
Logo used in the banner of the application
Image is smaller.
menu_primaryNav_sprite.png
Sprite containing background gradients for mouse over effects and the home icon used in the main menu
Home icons reduced in size and shadow effect added.
panel_inset_inset_bkgd.png
search_sprite.png
Icons used in search controls (search and clear search)
Images refactored. Input background removed.
tabs_horizontal_sprite.png
Background gradient images for the over and pressed states of horizontal tabs
Removed rounded corners. Colors adjusted.
tabs_vertical_sprite.png
Background gradient images for the up, over and pressed states of vertical tabs
Removed rounded corners. Colors adjusted.
“Images With No Modifications in 4.7” lists the images that have not been affected by the refactoring of themes in 4.7.
Images With No Modifications in 4.7
Image
Usage
adhoc_datatree_icons_sprite.png
Node and leaf images for fields, measures, and dimensions in the ad hoc data tree
floatingMenu_sprite.png
Popup menu icons for dashboard widgets
grid_20x20_bkgd.png
Grid background for dashboard designer canvas
list_node_animation.gif
Miniature “please wait” animation used in list nodes
list_pressed_bkgd.png
Background image for the top inner shadow that appears for the pressed state of a .list.filter list item
lists_sprite.png
Small icons used in various lists throughout the application. Also used for tokens, menus and OLAP cell sorting
loadinfo.gif
“Please wait” animation used for iPad only
message_icons_sprite.png
Sprite containing a single icon used for alert message
panel_sizer_sprite.png
Sprite containing icons for resizing panels and dialogs
report_load_animation.gif
Animation used in the toolbar of the interactive viewer when a report is loading
sort_indicators_sprite.png
Sprite containing icons used for the up, over, and pressed states of sortable lists (ascending and descending)
tabs_horizontal_buttons_bkgd.png
Image used as the top drop shadow for .tabSet.horizontal.buttons
wait_animation_large.gif
“Please wait” animation used in dialog boxes on page loads and in dashboard iframes when widgets are loading
“Images from Previous Default Theme Removed in 4.7” shows images used in the earlier themes that have been removed in 5.6, as well as images that have been refactored by placing them in the file inner_pagination_sprite.png.
Images from Previous Default Theme Removed in 4.7
Image
Usage
Notes
ajax-loader.gif
Animation used in the “please wait” dialog for printing dashboards that contain charts
replaced with wait_animation_large.gif
body_bkgnd.png
Gradient background image used as the body background for all pages
button_action_jumbo_sprite.png
Background images with rounded corners used for up, over, and pressed states of jumbo buttons
column_bkgd_corners.png
Background image used for rounded corners with drop shadow on column decorated elements
column_bkgd_edges_rl.png
Background image used for right and left borders with drop shadow on column decorated elements
column_bkgd_edges_tb.png
Background image used for top and bottom borders with drop shadow on column decorated elements
first-d.gif
Disabled state of “go to first” icon used for pagination controls inside report dashboard widgets
Image placed in sprite file inner_pagination_sprite.png
first.gif
“Go to first” icon used for pagination controls inside report dashboard widgets
Image placed in sprite file inner_pagination_sprite.png
frame_background_sprite.png
Gradient background image for the #frame element
frame_bkgd_corners.png
Background image used for rounded corners with drop shadow on the #frame element
frame_bkgd_edges_rl.png
Drop shadow image used for right and left edges of the #frame element
frame_bkgd_edges_tb.png
Drop shadow image used for top and bottom edges of the #frame element
frame_header_sprite.png
Gradient background image with rounded corners used for the header of the #frame element.
#frame header element holds the main navigation.
last-d.gif
Disabled state of “go to last” icon used for pagination controls inside report dashboard widgets
Image moved to sprite file inner_pagination_sprite.png.
last.gif
“Go to last” icon used for pagination controls inside report dashboard widgets
Image placed in sprite file inner_pagination_sprite.png.
login_welcome_bkgd_ipad.jpg
Main image on login page for iPad
logo_small.png
Logo used in the frame header/main navigation bar for iPad
menu_context_bkgd_corners.png
Background image used for rounded corners with drop shadow on .menu.context elements
menu_context_bkgd_edges_rl.png
Background image used for right and left borders with drop shadow on .menu.context elements
menu_context_bkgd_edges_tb.png
Background image used for top and bottom borders with drop shadow on .menu.context elements
menu_dropDown_bkgd_corners.png
Background image used for rounded corners with drop shadow on .menu.dropDown elements
menu_dropDown_bkgd_edges_rl.png
Background image used for right and left borders with drop shadow on .menu.dropDown elements
menu_dropDown_bkgd_edges_tb.png
Background image used for top and bottom borders with drop shadow on .menu.dropDown elements
menu_vertical_bkgd.png
Background for .menu.vertical
next-d.gif
Disabled state of next icon used for pagination controls inside report dashboard widgets
Image placed in sprite file inner_pagination_sprite.png.
next.gif
Next icon used for pagination controls inside report dashboard widgets
Image placed in sprite file inner_pagination_sprite.png.
panel_bkgd_corners.png
Background image of rounded corners with drop shadow used for the .dialog.overlay element
panel_bkgd_edges_rl.png
Background image of right and left borders with drop shadow used for the .dialog.overlay element
panel_bkgd_edges_tb.png
Background image of top and bottom borders with drop shadow used for the .dialog.overlay element
panel_dialog_header_sprite.png
Background for dialog headers
panel_info_bkgd_corners.png
Background image of rounded corners with drop shadow used for the .info element
panel_info_bkgd_edges_rl.png
Background image of right and left borders with drop shadow used for the .info element
panel_info_bkgd_edges_tb.png
Background image of top and bottom borders with drop shadow used for the .info element
panel_info_system_bkgd_corners.png
Background image of rounded corners used for the .info.system element
panel_info_system_bkgd_edges_rl.png
Background image of right and left borders used for the .info.system element
panel_info_system_bkgd_edges_tb.png
Background image of top and bottom borders used for the .info.system element
panel_info_tooltip_bkgd_corners.png
Background image of rounded corners used for the .panel.tooltip.info element
panel_info_tooltip_bkgd_edges_rl.png
Background image of right and left borders used for the .panel.tooltip.info element
panel_info_tooltip_bkgd_edges_tb.png
Background image of top and bottom borders used for the .panel.tooltip.info element
panel_inlay_bkgd_corners.png
Background image of rounded corners with drop shadow used for the .dialog.inlay element
panel_inlay_bkgd_edges_rl.png
Background image of left and right borders with drop shadow used for the .dialog.inlay element
panel_inlay_bkgd_edges_tb.png
Background image of top and bottom borders with drop shadow used for the .dialog.inlay element
panel_inlay_gradient_left.png
Left background image with gradient and rounded corners used for the .dialog.inlay .footer element
panel_inlay_gradient_right.png
Right background image with gradient and rounded corners used for the .dialog.inlay .footer element
panel_inset_bkgd_corners.png
Background image of rounded corners with drop shadow used for the .groupBox element
panel_inset_bkgd_edges_rl.png
Background image of left and right borders with drop shadow used for the .groupBox element
panel_inset_bkgd_edges_tb.png
Background image of top and bottom borders with drop shadow used for the .groupBox element
panel_widget_header_sprite.png
Background gradient with rounded corners used for the headers of the .panel.widget and .dialog.overlay.widget elements
prev-d.gif
Disabled state of Previous icon used for pagination controls inside report dashboard widgets
Image placed in sprite file inner_pagination_sprite.png
prev.gif
Previous icon used for pagination controls inside report dashboard widgets
Image placed in sprite file inner_pagination_sprite.png
toolbar_bkgd.png
Background gradient image for the .toolbar element
Data Snapshots
As of 4.7, 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 4.7 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.
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. |
Recommended Comments
There are no comments to display.