TIBCO JasperReports® Web Studio is the new visual designer tool for creating and editing report templates for the JasperReports® Library reporting engine and the whole TIBCO Jaspersoft® family of products that use this open source library to produce dynamic content and rich data visualisations. It comes as a web based alternative to the TIBCO Jaspersoft® Studio, the desktop application which is the most complete and most powerful design tool for JasperReports templates.
TIBCO JasperReports® Web Studio supports a few different deployment scenarios including standalone web application that can be run on its own, or can be added to existing TIBCO JasperReports® Server instances as a pluggable report editing feature.
|Please note the current version is a beta feature. It is not a fully tested feature and may not be fully stable. It is not supported and warranted. Please reach out Product Management (email@example.com) team to report any issues and/or share feedback.|
The standalone web application distribution of the TIBCO JasperReports Web Studio is called the Professional Edition and comes in the form of a ZIP package which contains everything you need to start the application on a Linux, Windows or MacOS machine.
After downloading the package from the TIBCO website, you can extract its contents to a folder of your choice on your target machine and then navigate to that folder using a termnal window and launch the start.sh or start.bat script found there.
By default, the application starts on http://localhost:8088, but the port and other configuration parameters can be changed in the start script if needed.
The web application opens up with a login screen where you have the option to connect to various types of repositories where reporting resources are stored, including TIBCO JasperReports Server instances, Google Drive accounts or GitHub projects.
Only the button to connect to an existing instance of TIBCO JasperReports Server is enabled by default, the other two login options for Google Drive and GitHub being disabled as they require additional configuration in the start script for the OAuth2 based authentication into this cloud platforms.
Connecting to JasperReports Server
One of the available buttons on the TIBCO JasperReports Web Studio - Professional Edition welcome screen allows users to connect to a JasperReports Server instance and manage the reporting resources available in its repository using specialized visual editors.
In addition to the usual JasperReports Server login credentials such as the organization/tenant ID, the user name and the password, the user needs to specify the URL of the JasperReports Server instance to connect to, as seen in the following screenshot:
Connecting to Google Drive
The login screen of the TIBCO JasperReports Web Studio shows a button that allows you to log into a Google Drive account and edit reporting resources stored there, but it requires that Google OAuth2 application registration information be specified in the start script of the application using system configuration properties.
The installer does not come with such Google Drive authorisation information preset in the application start script and this is why the respective login button is disabled.
In order to enable the Google Drive login button, you need to register your instance of the TIBCO JasperReports Web Studio with Google Drive by following the steps detailed on this page:
Once you have obtained the client ID and the secret key for your application at Google, you can set them in the start script of the TIBCO JasperReports Web Application using the following system properties added with a -D flag to the command that launches the Java Virtual Machine as follows:
Connecting to GitHub
The loing screen of TIBCO JasperReports Web Studio also feature a login button for connecting to GitHub in order to create and modify report template files stored in the GitHub project associated with the respective account.
The GitHub login button is also disabled by default as it requires OAuth2 application registration information to be specified in the application start script using system configuration properties. This startup provided authorization information allows the application to access to remote GitHub repositories and can be obtained by registering your local instance of TIBCO JasperReports Web Studio with GitHub by following the steps detailed on this page:
The client ID and the secret key provided by Github for your registered application can be set in the start script of the TIBCO JasperReports Web Studio using -D arguments in the command that launches the Java Virtual Machine:
After logging into the remote storage platform, the user is presented with the contents of the target repository and is able to navigate the folder structure or search for resources that need to be edited using the specialized editors that TIBCO JasperReports Web Studio offers.
Folders and files can be created, edited or removed, just like in any file system like repository.
There are currently two main types of resources that can be created and edited with TIBCO JasperReports Web Studio:
- report template files (JRXML)
- data adapter files
In addition to these two types of files for which the application features specialized visual editors, there is also the posibility to edit other types of files such as: properties files, style text templates files (JRTX), cascading stylesheet files (CSS) or general purpose XML files, using a more generic text based editor with syntax highlighting.
TIBCO JasperReports Web Studio's main feature is the editor for JRXML report templates. Just like in TIBCO Jaspersoft Studio, the editor has 3 main tabs for the visual designer, for the source JRXML editor and for the report preview. You can switch between these tabs using buttons at the top right corner of the application window.
The visual report designer consists of 3 main tools:
- design view
- outline view
- properties view
Depending on the area of the report template that is currently subject to editing, these views morph into more specialized variants which help edit specific parts of the report template such as the dataset, chart components, table or crosstabs, etc.
Data Adapter Editor
An important aspect of reporting is acquiring the data for the reports. This data usually comes from relational databases or other specialized data storage systems.
One of the main ways to acquire report data in TIBCO JasperReports Web Studio is by using data adapters, which are specialized files stored in the repository that contain information about how to connect to the systems that provide the data.
Data adapters could be of various types including relational database connections (JDBC), locally stored or remotely retrieved data files of CSV, XML, JSON or Excel type, etc.
For all these data adapter types, TIBCO JasperReports Web Studio features a specialized editor which allows creating and editing them.