JasperReports Data Matrix Generator Library

How to print Data Matrix barcode in iReport?

Top

1. Download the evaluation package and unzip
2. Create a new report in iReport, and add barcode.jar to report classpath from the downloaded trial package
3. Drag an image item in Palette to report
4. Click "Cancel" button, in "Select an image file" window
5. Right click on the image and edit its "Properties", and set property "Expression Class" to "net.sf.jasperreports.engine.JRRenderable";
6. To input Data Matrix barcode data manually, set property "Image Expression" to "new com.onbarcode.barcode.jasper.JasperRenderer(
   com.onbarcode.barcode.jasper.BarcodeGenerator.draw(100, "12345", "", "X=2&Y=2"))"
7. To print Data Matrix with data from database, please set property "Image Expression" to "new com.onbarcode.barcode.jasper.JasperRenderer(com.onbarcode.barcode.jasper.BarcodeGenerator.draw(100, $F{data field} + "", "", "X=2&Y=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 Data Matrix property table below

Data Matrix Valid Encoding Character Set

Data Matrix Maximum Data Length Size

Data Matrix Encoding Data Mode

Encode Non-Printable Chars in Data Matrix

Some ASCII characters are non-printable (e.g., Carriage Return [CR], Line Feed [LF]) and cannot be directly entered via keyboard. To encode these in Data Matrix, you'll need to use a specific format and configure the appropriate properties in the Report Item Property panel.

• Select the Data Matrix and open the Report Item Property panel.
• Set the "ProcessTilde" property to "true". This enables the use of "~" to represent non-printable characters (formatted as "~ddd", where "ddd" is the three-digit ASCII value).
• Set the "DataMode" property to "DataMatrixDataMode.Base256". This mode supports encoding all byte values, including non-printable characters.
• In the "Data" field, enter the non-printable character in the format "~ddd". For example, to encode [CR], enter "Data~013Matrix" (inserts [CR] between "Data" and "Matrix").
• If using dynamic data, use an Expression (e.g., "$F{NonPrintData}") where the Field stores the formatted string (e.g., "Data~013Matrix").
• Save the JRXML template to apply the settings.

Encode Unicode Text in Data Matrix

You can easily encode Unicode text (e.g., Arabic, Chinese, Cyrillic) into Data Matrix in JasperReport reports using the Report Item Property panel. This is useful for international reports that require non-ASCII text encoding.

• Select the Data Matrix and open the Report Item Property panel.
• Locate the "EncodeUnicodeText" property and set it to "true". It enables the JasperReports Library to encode Unicode text from the "Data" field.
• Enter the Unicode text into the "Data" field. For dynamic data, use an Expression like "$F{UnicodeData}" to reference the Field storing the text.
• Set the "DataMode" to "DataMatrixDataMode.Auto". The library will automatically select the optimal mode for Unicode encoding.
• Save the JRXML template to apply the settings.

More Data Formats to Encode in Data Matrix

Quick to Create Data Matrix with Specified Width

Data Matrix is typically square, so setting the width will automatically adjust the height to maintain a 1:1 aspect ratio. Follow these steps to set a specific width.

• Open the Report Item Property panel of the Data Matrix.
• Locate the "BarcodeWidth" property and enter the desired width (e.g., 900 pixels). The height will automatically match the width to maintain a square shape.
• Save the JRXML template to apply the setting.

Note: Avoid setting the width too large, as it may overlap with other Report Elements (e.g., Static Text (Fixed label text), Text Field (Dynamic field displaying data/variables)).

Generate Rectangular Data Matrix with Specified Width and Height

Data Matrix (ECC200) supports 6 rectangular symbols with specific row and column configurations. To create a rectangular Data Matrix, you'll need to set the "FormatMode" property and match the width-height ratio to the row-column ratio of the selected format.

List of the size rectangular format:

• 8 rows x 18 columns
• 8 rows x 32 columns
• 12 rows x 26 columns
• 12 rows x 36 columns
• 16 rows x 36 columns
• 16 rows x 48 columns

• Open the Report Item Property panel.
• Set the "FormatMode" property to the desired rectangular format (e.g., "DataMatrixFormatMode.Format_16X48" for 16 rows x 48 columns).
• Set the "BarcodeWidth" and "BarcodeHeight" properties to match the row-column ratio of the selected format. For example, 16 rows x 48 columns has a 1:3 ratio, so set "BarcodeWidth" to 900 and "BarcodeHeight" to 300.
• Enter the data to encode in the "Data" field (static or dynamic via Expression).
• Save the JRXML template to apply the settings.

Note: If the data exceeds the maximum capacity of the selected rectangular format, the JasperReports Library will automatically select a larger format to accommodate the data.

Advanced Data Matrix Dimension Settings

Colors in Data Matrix

By default, Data Matrix uses a dark (black) foreground (bars) and light (white) background (spaces), but you can customize these colors to align with your report's style. Ensure high contrast between foreground and background to maintain readability.

Configure the color properties:

• ForeColor: Set the color of the Data Matrix's bars (default: Black). You can select a predefined color or enter a custom RGB value (e.g., #FF0000 for Red).
• BackColor: Set the color of the Data Matrix's spaces (default: White).

Example configurations:

• Standard dark-on-light: ForeColor = Black, BackColor = White (default).
• Light-on-dark: ForeColor = White, BackColor = Black.
• Custom color: ForeColor = Red, BackColor = White (ensure high contrast).

Image Settings in Data Matrix

Data Matrix Format Mode

The Data Matrix ISO standard specifies 24 square symbols and 6 rectangular symbols for ECC 200. Each symbol size has a specific number of rows and columns, which determines its data capacity. You can manually select the Format Mode in the Report Item Property panel to control the Data Matrix size.

• Select the Data Matrix and open the Report Item Property panel.
• Locate the "FormatMode" property and select the desired symbol size (e.g., "DataMatrixFormatMode.Format_48X48" for a 48x48 square Data Matrix).
• Enter the data to encode in the "Data" field.
• Save the JRXML template to apply the setting.

Note: If the data exceeds the maximum capacity of the selected FormatMode, the JasperReports Library will automatically select a larger format to ensure all data is encoded.

Data Matrix Structured Append Mode

Structured Append mode allows you to split large data into blocks and store it across multiple Data Matrix symbols (up to 16). This is useful for encoding data that exceeds the maximum length of a single Data Matrix.

• Select the Data Matrix and open the Report Item Property panel.
• Set the "StructuredAppend" property to "true" to enable the mode.
• Configure the following properties:
  • SymbolCount: The total number of Data Matrix symbols needed to store the entire data message (e.g., 3 for splitting data into 3 symbols).
  • SymbolIndex: The position of the current Data Matrix in the sequence (starts at 0 for the first symbol).
  • FileId: A unique integer (e.g., 999) that identifies all symbols belonging to the same data message. All symbols must have the same FileId.
• Enter the portion of the data to encode in the current Data Matrix (e.g., the first 100 characters for SymbolIndex 0).
• Repeat the process for each symbol (adjust SymbolIndex for each Data Matrix).
• Save the JRXML template for each symbol (or use a Subreport (Embedded nested report) to generate multiple symbols in a single report).

Data Matrix FNC1 in the First Position

When FNC1 appears in the first position of a Data Matrix, it signals that the encoded data conforms to the GS1 Application Identifier (AI) standard. This is commonly used in supply chain and retail reports to encode product information (e.g., GTIN, batch number).

• Select the Data Matrix and open the Report Item Property panel.
• Locate the "FNC1" property and set it to "FNC1.FNC1_1ST_POS".
• Enter the GS1 data in the "Data" field, with AI codes surrounded by parentheses (e.g., "(01)12345678901234(10)ABC123").
• Set the "DataMode" to "DataMatrixDataMode.Auto" to ensure correct encoding.
• Save the JRXML template to apply the setting.

Note: Ensure the AI codes and data lengths comply with the GS1 standard. Incorrect formatting will prevent the scanner from recognizing the GS1 data.

iReport Barcode Data Matrix Generator - Property Settings

Top