JasperReports QR Code Generator Library

How to generate QR Code barcodes in iReport?

Top

1. Create a new report, and add barcode.jar to report classpath from the downloaded trial package
2. Drag an image item in Palette to report
3. Click "Cancel" button, in "Select an image file" window
4. Right click on the image and edit its "Properties", and set property "Expression Class" to "net.sf.jasperreports.engine.JRRenderable";
5. To input QR Code barcode data manually, set property "Image Expression" to "new com.onbarcode.barcode.jasper.JasperRenderer(
   com.onbarcode.barcode.jasper.BarcodeGenerator.draw(102, "12345", "", "X=2"))"
6. To print QR Code with data from database, please set property "Image Expression" to "new com.onbarcode.barcode.jasper.JasperRenderer(
   com.onbarcode.barcode.jasper.BarcodeGenerator.draw(102, $F{data field} + "", "", "X=2"))";
   
   BarcodeGenerator.draw method accepts 4 parameters:
   the second is the barcode data to encode, in String,
   the last is the barcode settings String. More details about barcode settings string, please check the QR Code property table below

QR Code Encodable Character Set

QR Code Data Mode

Maximum Data Length per QR Code

Encode ASCII Non-Printing Characters

ASCII non-printing characters (e.g., Carriage Return [CR]) require special configuration to encode into QR Codes. Follow these steps:

• Open the Report Item Property panel for the Barcode Component (QR Code type).
• Set the "ProcessTilde" property to "true" (enables the use of "~" to represent special characters).
• Set "DataMode" to "Auto" (the tool will automatically detect the encoded character).
• In the "Data" field, enter the non-printing character as a three-digit ASCII value prefixed with "~" (e.g., "~013" for [CR]).
• Save the JRXML template.

Note: If the QR Code fails to decode, verify that "ProcessTilde" is set to "true" and the ASCII value is correctly formatted as "~ddd".

Encode Unicode Text (International Languages)

QR Code does not support Unicode text by default. To encode international text (e.g., Thai, Arabic), use one of two methods: convert the text to a UTF-8 byte array and use Byte mode, or use ECI mode. Below is the UTF-8 byte array method:

• Open the Report Item Property panel for the QR Code.
• Set "ProcessTilde" to "true" (enables encoding of byte values).
• Set "DataMode" to "Byte" (required for encoding UTF-8 byte arrays).
• Convert the Unicode text to a UTF-8 byte array and format each byte as "~ddd" (three-digit value prefixed with "~"). For example:
  
  Thai text "สวัสดี" converts to a UTF-8 byte array; each byte is formatted as "~ddd" (e.g., "~224~184~165..." for the full text).
• Enter the formatted byte string into the "Data" field of the Report Item Property panel.
• Save the JRXML template.

Encode GS1 QR Code

GS1 QR Code is a specialized format for encoding GS1 data elements (Application Identifier [AI] code + data). Follow these steps to generate it:

• Open the Report Item Property panel for the QR Code.
• Set the "FNC1" property to "FNC1.FNC1_1ST_POS" (enables GS1 encoding).
• Set "DataMode" to "Auto" (the tool will detect the GS1 format).
• Enter the GS1 data (with AI codes in parentheses) into the "Data" field.
• Save the JRXML template.

Note: Ensure the AI codes are properly formatted in parentheses; missing parentheses will cause encoding errors.

Encode Binary Data

Encode Kanji Text

QR Code Dimension (Width and Height)

Quiet Zone Configuration

The Quiet Zone is the empty space around the QR Code (required for scanners to detect the code). You can set the Quiet Zone using four margin properties in the Report Item Property panel.

• Select the QR Code and open the Report Item Property panel.
• Set the following margin properties to the desired value (e.g., 50 pixels each):
  • LeftMargin: Empty space on the left of the QR Code.
  • RightMargin: Empty space on the right.
  • TopMargin: Empty space at the top.
  • BottomMargin: Empty space at the bottom.
• Save the JRXML template.

Note: The recommended Quiet Zone is at least 4 modules (pixels) wide; smaller margins may cause scanning issues.

QR Code Color Customization

You can customize the QR Code's foreground (bar) and background (space) colors via the Report Item Property panel.

• Select the QR Code and open the Report Item Property panel.
• Set the "ForeColor" property to the desired bar color (e.g., Red).
• Set the "BackColor" property to the desired background color (e.g., White).
• Save the JRXML template.

Note: Use high-contrast colors (e.g., black foreground on white background) for best readability; low-contrast colors may make the QR Code unreadable.

Error Correction Level (ECL)

QR Code Version

Structured Append Mode

Structured Append mode allows splitting large data into up to 16 QR Codes (symbols) that can be scanned in sequence to reconstruct the full data.

• Select the QR Code and open the Report Item Property panel.
• Set "StructuredAppend" to "true" (enables the mode).
• Set "SymbolCount" to the total number of symbols (e.g., 3 for three QR Codes).
• Set "SymbolIndex" to the position of the current symbol (0 for the first symbol, 1 for the second, etc.).
• Enter the portion of the data assigned to this symbol in the "Data" field.
• Repeat for each symbol (create a separate QR Code for each index).
• Save the JRXML template.

Note: Ensure all symbols have the same "SymbolCount" and unique "SymbolIndex" values; mismatched values will prevent data reconstruction.

FNC1 in First Position

This mode identifies the QR Code as encoding GS1 data (as covered in Section 3.3). To enable it.

• Select the QR Code and open the Report Item Property panel.
• Set the "FNC1" property to "FNC1.FNC1_1ST_POS".
• Enter the GS1 data in the "Data" field (with AI codes in parentheses).
• Save the JRXML template.

iReport Barcode QR Code Generator - Property Settings

Top