System Configuration

You can change the default behavior of JasperReports Server by editing the system’s configuration. The configuration is defined by a set of properties and their values.

The properties are stored in configuration files located in various folders under the <js-install> directory, which is the root of your JasperReports Server installation. To change the configuration, you edit these files and then restart the server.

A few of the most commonly edited properties are available to the system admin through the user interface (UI). Changes to these properties take effect immediately, are stored in the repository, and override the equivalent values stored in files, even after the server restarts (as of version 5.0).

This chapter describes a subset of the properties in the configuration files. Settings that affect security are covered in Application Security. Configuration of the auditing feature is covered in Configuring Auditing and Monitoring. More options are described in the JasperReports Server Installation Guide.

Because the locations of files described in this chapter vary with your application server, the paths specified here are relative to the deployed WAR file for the application. For example, the applicationContext.xml file is shown as residing in the WEB-INF folder; if you use the Tomcat application server bundled with the installer, the default path to this location is:

C:\Program Files\jasperreports-server-6.0\apache-tomcat\webapps\jasperserver-pro\WEB-INF

Use caution when editing the properties described in this chapter. Inadvertent changes may cause unexpected errors throughout JasperReports Server that may be difficult to troubleshoot. Before changing any files, back them up to a location outside of your JasperReports Server installation.

Do not modify settings that are not described in the documentation. Even though some settings may appear straightforward, values other than the default may not work properly and cause errors.

This section describes functionality that can be restricted by the software license for JasperReports Server. If you don’t see some of the options described in this section, your license may prohibit you from using them. To find out what you're licensed to use, or to upgrade your license, contact us.

In addition to configuration described in this chapter, you can configure Liferay Portal or JBoss Portal to display the reports stored in your JasperReports Server instance. You can download the JasperReports Server portlets for these environments from the Jaspersoft Support Portal. For information about how to deploy the portlet, refer to the documentation in the portlet download package.

This chapter contains the following sections:

Configuration Settings in the User Interface
Configuration for Using Proxies
Configuration for Session Persistence
Configuring Ad Hoc
Enabling Data Snapshots
Configuring System Logs
Configuring Amazon Web Services
Configuring Domains
Configuring JasperReports Library
Configuring Input Control Behavior
Configuring the Scheduler
Configuring the Heartbeat
Configuring the Online Help