Jaspersoft Quick Start Guide

Getting Started Video

Welcome to the Jaspersoft Quick Start Guide. Before you dive in, watch a short video for an overview of Jaspersoft use cases and capabilities.

Install and Configure

Got Jaspersoft?

If you haven't already downloaded Jaspersoft there are a few options available:

  Platforms Supported Best Used For Where to Get It Read Documentation
Platform Installers   Proof of concept, Evaluation Download Now Documentation
Virtual Machines   Proof of concept, Evaluation Download Now Documentation
WAR File   Production on own application server Contact Our Sales Team Documentation
Docker   Production for SaaS & Cloud Apps Request WAR file & Fork on Github Documentation
Amazon Web Services   AWS Environments Launch an Instance Now Documentation
Other Downloads
Jaspersoft Studio   Pixel Perfect Report Design Download Now Documentation
Jaspersoft ETL   Data Integration Studio Contact Our Sales Team Documentation
Jaspersoft Mobile   Consuming Assets from Mobile Download for iOS
Download for Android

Supported Platforms

Jaspersoft supports a robust platform stack to meet the needs of almost every organization. The table below contains a summary of supported platforms. For details on specific version numbers and timeframes to support different platforms, please consult the Platform Support Datasheet (PDF)

  Web Browsers Mozilla Firefox, Microsoft Internet Explorer & Edge, Apple Safari, Google Chrome
Data Sources
  • Relational: Most JDBC compatible relational databases like MySQL, Oracle
  • MPP: Many massively parallel databases like Teradata, Pivotal Greenplum
  • Hosted: Many hosted databases like Amazon Redshift, Microsoft SQL Azure
  • NoSQL: NoSQL Data sources like MongoDB, Cassandra
  • Big Data: Big Data support for Hadoop Hive, Impala, Spark
Repository Database
  • All Jaspersoft Editions: PostgreSQL, MySQL
  • Commercial Editions Only: Oracle RDBMS, IBM DB2, Microsoft SQL Server
  • All Jaspersoft Editions: Oracle HotSpot JDK
  • Commercial Editions Only: IBM JDK, OpenJDK  
Application Servers
  • All Jaspersoft Editions: Apache Tomcat
  • Commercial Editions Only: JBOSS Wildlfy, Glassfish, Web Logic, WebSphere
Operating Systems Microsoft Windows, Linux, Unix, Apple macOS, 

Hardware Requirements

The following are minimum hardware requirements for running JasperReports Server. Production implementations with higher loads can be load balanced. The repository database is suggested to be run separately from the Jaspersoft application. Refer to the Installation Guide for more details.

  Minimum Recommended
Disk 10GB (footprint is 1.3GB) 40GB+
Memory 4GB 8GB+
Processor 2 cores 4+ cores

Working with Data

Connecting to and Describing Your Data

Establishing Your Data Source Connection

In order to connect to your data you will need to create a connection to your data source, typically through a JDBC driver.

Creating Domains that Represent Your Data

In order to connect to your data you will need to create a connection to your data source, typically through a JDBC driver. Create a Domain with the Domain Designer, an easy-to-use wizard within JasperReports Server

Visualizing and Interacting with Your Data

Creating Ad Hoc Views

JasperReports Server lets you analyze data using chart visualizations or tabular views against predefined Topics, Domains, or OLAP connections. The Ad Hoc report designer is the primary tool in JasperReports Server for analyzing data. To get started, select the Create>Ad Hoc View menu item and follow the workflow. The following tutorial shows an example of creating ad hoc views.


JasperReports Server allows users to quickly create dashboards containing multiple reports from the repository along with external content. With dashboards you create a single comprehensive view of key business metrics for managers and executives. This video shows how to build and interact with a dashboard

Interactive Reporting for Non-Technical Users

This tutorial shows how to view and interact with reports in the server. These reports can be made in the Ad Hoc Editor, more complex designs can be made in Jaspersoft Studio.

Creating Your First Report with Jaspersoft Studio

Jaspersoft Studio is a flexible and robust development environment for creating custom reports leveraging the full power of the JasperReports reporting engine.

Using Jaspersoft on Mobile Devices

TIBCO JasperMobile are native applications for your iOS or Android devices that let you browse, view, and interact with reports and dashboards from JasperReports Server. Additionally, JasperMobile comes with an SDK that allows you to build your own mobile apps and leverage mobile analytics.

Report Distribution

Scheduling your Report Execution and Delivery

JasperReports Server provides report scheduling and distribution. Based on a one-off or recurring schedule you configure via UI or GUI, reports are automatically executed and saved to the repository in up to eleven formats. They can be emailed, sent to FTP or file system via API You can also include links to the reports, include the reports as HTML in the body of the email message, or attach the reports.

Securing Your Data

Data-level security is a common requirement and restricts content displayed in an Ad Hoc report based on the user’s profile. Data-level security in JasperReports Server is enforced through an XML security file attached to a Domain.

Integrate and Embed

JasperReports Server provides several interfaces that allow you to integrate or embed BI into your apps. You want to integrate two key areas: authentication and the user interface. The user interface can be embedded using three different methods:

Single Sign-On Authentication

Implementing single sign-on (SSO) results in a user being able to log in to JasperReports Server based on a shared login mechanism and ID. Common external authentication mechanisms include external DB, LDAP, CAS, and Token Based Authentication. The following videos gives an introduction to these authentication methods:

User Interface Themes/Skins

Interactive Reporting for Non-Technical Users

The JasperReports Server application can be customized to match the appearance of another application and rebrand the user interface. CSS-based themes allow a set of changes to be packaged together in one view. Themes are stored in the repository and are part of the JasperReports Server UI framework that provides separation of structure, presentation, and events.

Embedding Methods


Visualize.js is a JavaScript API framework used to embed JasperReport Server reports & visualizations inside web applications. It offers the most flexibility when it comes to UI design and interactivity.


Reports, dashboards and parts of the Jaspersoft application can be called via HTTP and embedded via iFrames into your applications, even the dashboard and Ad Hoc designers can be embedded.

Web Service APIs

The REST Web Service APIs allow components of JasperReports Server to be integrated into other applications via Web Service calls by the hosting application. This includes repository services, scheduling services, Domain services and administrative services. Web Service requests are authenticated using Spring Security and can be configured to use HTTPS.

Additional Resources

Tutorials and API Samples

Visualize.js API Examples

View and interact with live Visualize.js API samples.

View Now

Fresh Delivery Demo

Play with an embedded BI application, fork it on Github

View Now


See our "0 to Dashboards" Workshop

View Now

Additional Documentation

Official Documentation

Read the Offical Docs online or as PDF

View Now

YouTube Channel

Watch tutorials, demos and more

Wiki Pages

Browse through thousands of solutions to common problems.

View Now

Contact Us for Evaluation Help

Contact Us

Write us via our contact form

Contact Us

Live Chat

Look for this icon on any page

Ask on Community

Ask technical questions

View Now