18 Sep 2024

How to Install JasperReports Server: A Step-by-Step Guide

JasperReports Server is a powerful, open-source, and highly scalable platform used by organisations for generating and distributing detailed reports and dashboards. It supports data visualization, reporting, and analysis, making it an ideal tool for business intelligence needs. Data Terrain leverages its expert management and automation capabilities to streamline the deployment of JasperReports Server. This guide will walk you through the installation process and explain how to customize the server for your environment.

Installation of Jaspersoft Report Server

Installation Requirements for JasperReports Server

Before you start the installation, make sure you have the following system components set up:

1. Java Development Kit (JDK)

JasperReports Server requires JDK 8. Ensure that the Java environment variable JAVA_HOME is correctly configured, as it is essential for the server to run smoothly.

2. Database System

JasperReports Server supports multiple database systems such as PostgreSQL, MySQL, and Oracle. While the installer comes with PostgreSQL, you can use an existing database by setting it up in advance.

3. Optional Application Server

Though JasperReports Server includes Apache Tomcat by default, you can also deploy it on a custom application server, such as JBoss or an independent installation of Tomcat. This flexibility is useful if any issues arise during deployment.

Methodical Installation of JasperReports Server

There are two primary installation methods for JasperReports Server: the binary installer approach and the manual deployment method. We'll cover both in detail.

Step 1: Download JasperReports Server

Visit the Jaspersoft community site and download the appropriate JasperReports Server package for your platform. You can choose between the Community and Enterprise versions based on your needs.

Step 2: Launch the Binary Installer

The binary installer is the easiest way to install JasperReports Server, as it includes both PostgreSQL and Apache Tomcat.

Step 3: Extract and Install

After downloading the installer:

On Linux/Unix : Navigate to the installation directory and run the following command: ./js-install.sh

On Windows : Open the Command Prompt and run: js-install.bat

During the installation process, you will be prompted to choose whether you want to use the included PostgreSQL or an external database. Make your selection according to your requirements. The installer will deploy JasperReports Server along with a preconfigured Tomcat server and a PostgreSQL instance.

Setting Up an External Database

If you choose to use an external database (e.g., MySQL, Oracle, or SQL Server), follow these steps:

1. Open the buildomatic folder from within your JasperReports installation.

2. Edit the default_master.properties file to configure your database settings.

3. Run the following command to set up the database structure: ./js-ant create-js-db

This process applies the necessary configurations and creates the required database tables.

Deploying JasperReports Server in a Web Container

If you prefer using a custom application server (such as a standalone Apache Tomcat), follow these steps to deploy the WAR files:

1. Copy the WAR files from the buildomatic folder to the webapps directory of your web container.

2. Ensure your web container’s lib directory contains the appropriate database drivers (e.g., MySQL Connector/J).

3. Restart your web container and access JasperReports Server by navigating to: http://localhost:8080/jasperserver

Post-Installation Configuration

After installation, there are several important configurations to optimize JasperReports Server for performance and security.

1. Login and Change Default Credentials

Username : superuser
Password : superuser

For security reasons, change these credentials immediately after logging in.

2. Email Configuration

To enable report scheduling via email, update the SMTP settings in the js.quartz.properties file located in the WEB-INF directory.

3. Security Configuration

Change all preset passwords.
Configure SSL on Tomcat or your web server to enable HTTPS.
Set up user roles and permissions to restrict access based on user profiles.

If you’re using an external database, execute: ./js-ant create-js-db

This will finalize your database configuration.

Optimizing Performance

To ensure optimal performance in production environments, adjust the server's RAM allocation in Tomcat's JAVA_OPTS settings.

Conclusion

Installing and configuring JasperReports Server involves a straightforward process of setting up the environment, running the installer, and establishing database connections. With proper configuration and security measures, JasperReports Server can be a powerful tool for delivering business insights through customizable reports and dashboards.

DataTerrain specialised in Automated BI Migration solutions, having successfully partnered with over 270 clients worldwide. Our cutting-edge technology and deep expertise in BI migration, report conversion, and ETL solutions enable businesses to seamlessly transform their data ecosystems. Whether it’s optimizing reporting systems or migrating to advanced platforms like Jaspersoft and Cognos, DataTerrain ensures a smooth, efficient transition, empowering organizations to unlock the full potential of their data.