Skip to Main Content

Print Templates 101: Jaspersoft Studio

Print Template Editors

There are ready to use default print templates provided within your Innovative system.  However, you can also create custom print templates using 3rd party software.  Innovative supports the following 3rd party software.  Be aware that different versions of your system require using different versions of supported software:

Sierra Window's Version --  supported 3rd party software

  • Sierra 2.0 SP1 & earlier -- iReport v. 4.0.2
  • Sierra 2.0 SP2 & later -- Jaspersoft Studio v. 6.0.0 32bit | 64bit

For Mac or Linux versions visit the CSDirect Downloads (Log-in Required) web page.

Required:  A Java Runtime Environment (JRE) is required to run iReport.  This Java software is free and can be downloaded from java.com.

Installing Jaspersoft Studio 6.0.0

Installation Hints for Jaspersoft Studio 6.0.0

There maybe a security warning after downloading Jasper Studio from CSDirect.  The following image shows this error after downloading the software with Internet Explorer.

Download Security Signature Error With Internet Explorer

 

This error is due to a signature issue with the installer, and it's alright to proceed with running the Jaspersoft Studio program installer.  Another error you may see with Windows 8 or Windows 10 after initiating the installer is shown in the image below.

Jaspersoft Installer Windows SmartScreen Warning More Info

 

Select the "More info" link, and the window will change to the following:

Jasperstudio Installer SmartScreen Run anyway

 

Now select "Run anyway" to launch the Jaspersoft Studio 6.0.0 installation wizard.

Back to Top

Jaspersoft Studio Workspace

When Jaspersoft Studio is ran for the first time after installation.  The program will ask about setting up the default "workspace".  This dialog is shown in the image below.

Japsersoft Studio Default Workspace

 

Most likely this is set to the default file path which can lead to some confusion when trying to locate print template files.  However, it is possible to change the define "workspace".  To change the "workspace" select "Switch Workspace" from the File menu within Japsersoft Studio.

Jaspersoft Studio Switch Workspace

 

The following dialog box will be shown, and a new "workspace" path can now be defined.

Jaspersoft Studio Define New Workspace 

 

It is advised to keep all the print template files together.  The above image shows that the new workspace will be located within the Sierra Desktop App directory (C:\Sierra Desktop App\Print Templates\Jaspersoft).  After selecting "OK" Jaspersoft Studio will switch over to the newly defined workspace.

Jaspersoft Studio Switch to New Workspace

 

Remember that all new template files will be stored in the current defined workspace.

 Back to Top  

Jaspersoft Studio 6.0.0 Editor Layout in Detail

Panels in Jaspersoft Studio
After opening a default template in Jaspersoft Studio (6.0.0), the default window should look similar to the following:

Jasperstudio Editor Opening Layout

 

Files
This shows the .jrxml files (print template file extension) currently open and being edited in Jaspersoft Studio (6.0.0):

Jasperstudio Open Files Tab

 

Another thing to note is if you see an asterisk by the file name, this is a visual clue that the file(s) has not yet been saved.

 Back to Top

Outline View Panel
The Outline View (Document Structure) panel:

Jasperstudio Editor Outline View Panel

 

The following icon within the Outline View panel...


Jasperstudio Editor Bands Icon

...represents a "band." A band is generally different sections within the template.

 

This shows the different bands (sections) of the template in expanded view:


Jasperstudio Editor Expanded Bands View

 Back to Top

Bands And Their Description

  • Title-is printed only one time and it's the first band. It can be printed on a separate page.
  • Page header-is printed on each page.
  • Column header-is printed on each page that contains a detail band. If a page is split in one or more columns, this band is printed on each column.
  • Detail-is printed for each record in the source. Corresponds to every record which is read by the data source; usually one record, although for purchase orders it will correspond to multiple order records. Most of the print elements will be placed here. If using multiple records, the height of this band is the space given to each record.
  • Column footer-is printed on each page that contains a detail band. If a page is split in one or more columns, this band is printed on each column.
  • Page footers-is printed on each page. This is a good place where put something like "Page X of Y."
  • Summary-is printed only one time at the end of the report. It can be printed on a separate page.
  • Background-Is a special band that can be used to define a page background.

 

A couple of things to remember:

  • Make sure to use a Text Field for fields that requires Java code. Don't use Static Text fields.
  • Horizontal portions of a document are always the width of the page. The height of the bands can be easily manipulated, but the sum of all band heights (except "Background") must be less than or equal to the page height minus margins. To eliminate unwanted bands, make their height 0 in Properties (or drag other bands up or down).

 Back to Top

Properties View Panel
The Properties panel advanced view:

 

 

To show the properties for a certain element, select the element within the "Outline View".  Then select to view the "Properties" tab. (Toolbar | Window | Show View | Properties).

Jasperstudio Editor Outline Element Properties View


The Properties View panel contains the properties for whatever element is selected. If you haven't clicked on a particular element, the properties are for the entire form (called a "Report" in Jasperstudio). You can change the size, margins, orientation and other properties of the form here.

There is also an editor available for some element properties such as a "Text Field".  The following image shows the Properties View panel for the Text Field in a print template with the Expression Editor button outlined in red.

Jaspersoft TextField Properties Editor Button

 

After clicking on the button the TextField Expression Editor will appear.

 

 Back to Top

Fields
There are two types of fields available. One type is called "Text Field",  and this field represents the data available from the template's data library coming from your system (Sierra/Millennium).  The second type is called "Static Text", and this field is used for text that doesn't change like a label. The following image shows the Text Field and Static Text field icons.

Jasperstudio Editor Fields Icon

Remember with each field you can also look at the "Properties".

 

This shows the different fields (text field/static text) of the template in expanded view:

Jasperstudio Editor Expanded Fields View

 Back to Top

Palette
The palette displays the basic fields which can be added to a template (Toolbar | Window | Show View | Palette). These elements are then populated with text, images, or data fields from your system.

Jasperstudio Editor Palette View Panel

 Back to Top

Preview and Report State View
After making changes to a template it is advised to use the "Preview" tab.  

Jasperstudio Editor Preview Tab

By selecting this tab the template is automatically compiled and checked for any errors. The more advanced the template becomes previewing it often can help troubleshoot any errors with the template. These errors will show in the "Report State View".

 

This shows the Report State View with errors.  This can be useful when troubleshooting errors with templates:

 Jasperstudio Preview Tab Report State View

 Back to Top