How to generate, print Data Matrix in BIRT reports?

Generate barcode Data Matrix images in BIRT Reports

BIRT Data Matrix Generator to Generate DataMatrix in BIRT Reports

Easy to generate Data Matrix barcodes in BIRT reports
Simple to redistribute BIRT Data Matrix barcode library (jar)
No registration key or activation code needed
Generating high quality Data Matrix Bar Code images in GIF format
Completely developed in Eclipse BIRT Custom Extended Report Item framework
Mature BIRT Data Matrix barcode generation plugin using Java Barcode Generator library

Let me guide you step by step to generate Data Matrix 2D barcode images directly in BIRT (Business Intelligence and Reporting Tools) reports within your Eclipse Java projects. All Data Matrix properties are configured exclusively in the Report Item Property view of your Report Design (.rptdesign).

Here you will learn:

How to set up your Eclipse + BIRT environment for Data Matrix generation
Core configuration steps using BIRT Report Designer and Report Item Property
Advanced encoding (non-printable characters, Unicode, GS1) and sizing customization
Validation best practices to ensure accurate barcode rendering

How to create, print Data Matrix 2d barcodes in Eclipse BIRT reports?

Download BIRT Data Matrix Generator plugin
Install BIRT barcode generation plugin jar file into BIRT report project
Start to Create

BIRT Barcode Data Matrix Generator Introduction

Top

BIRT Barcode is an Eclipse BIRT Custom Extended Report Item which helps you easily generate and print high quality 1D (linear) and 2D (matrix) barcodes in your BIRT reports.

Barcode Data Matrix Introduction

Data Matrix code is a two-dimensional matrix barcode consisting of black and white "cells" or modules arranged in either a square or rectangular pattern. The information to be encoded can be text or raw data. Usual data size is from a few bytes up to 2 kilobytes. The length of the encoded data depends on the symbol dimension used. Error correction codes are added to increase symbol strength: even if they are partially damaged, they can still be read. A Data Matrix symbol can store up to 2,335 alphanumeric characters.

BIRT Data Matrix Generator - Valid Data Scope

All 128 characters of ASCII
Values 128-255 in accordance with ISO 8859-1. There are referred to as extended ASCII.

Data Matrix Generators

OnBarcode provides several Data Matrix Generator components and software, including .NET Data Matrix Generator, Java Data Matrix Generator, C# Data Matrix Generator, iPhone Data Matrix Generator, iPad Data Matrix Generator, Android Data Matrix Generator, VB.NET Data Matrix Generator, Data Matrix Generator.

How to Generate Data Matrix in BIRT Report

Top

Below is a quick look for generating & printing Data Matrix 2D barcodes in BIRT.
For detailed developer guide, please view here: BIRT Barcode Generator - Developer Guide

Copy com.onbarcode.barcode.birt_2.2.1.jar to your Eclipse plugins directory "\eclipse\plugins\"
Create a new empty report in your BIRT Report barcoding project
Open View "Palette", and add report item "Barcode" to your created BIRT report
Right click the report item you have added, and select "Properties" menu item to edit barcode parameters
You will find all barcode properties in the "General" tab. Please note that the values for "Data" and ""UPC/EAN Supplement Data" should be arounded by """, unless you are inputting expression
Click preview and a Code 128 barcode image is printed on your BIRT report, please change Barcode Type into Data Matrix in the general tab
If you want to encode barcode data from BIRT report data set, please input expression to "Data" property. eg. "row["CUSTOMERNUMBER"]"

BIRT Barcode Data Matrix Generator - Property Settings

Top

Category

Properties

Value

Comments

Basic

Property: Data

Type: expression
Default: ""

If you encode the barcode data text directly, the text string should be around by " " ", such as "12345"
If you encode the barcode data from dataset, input the expression, such as row["CUSTOMERNUMBER"]

Barcode value to encode

Data Matrix Valid Data Char Set:

ASCII values 0 - 127 in accordance with the US national version of ISO/IEC 646

NOTE: This version consists of the G0 set of ISO/IEC 646 and the C0 set of ISO/IEC 6429 with values 28 - 31 modified to FS, GS, RS and US respectively.
ASCII values 128 - 255 in accordance with ISO 8859-1. These are referred to as extended ASCII.

Data Matrix
Special

Property: processTilde
URL: PROCESS-TILDE

Type: bool
Default: true

Set the processTilde property to true, if you want use the tilde character "~" to specify special characters in the input data. Default value is true.

1-byte character: ~0dd/~1dd/~2dd (character value from 000 ~ 255); ASCII character '~' is presented by ~126
Strings from "~256" to "~299" are unused
2-byte character (Unicode): ~6ddddd (character value from 00000 ~ 65535)
Strings from "~665536" to "~699999" are unused
for GS1 AI Code:
~ai2: AI code with 2 digits
~ai3: AI code with 3 digits
~ai4: AI code with 4 digits
~ai5: AI code with 5 digits
~ai6: AI code with 6 digits
~ai7: AI code with 7 digits
ECI: ~7dddddd (valid value of dddddd from 000000 to 999999)
~rp: Reader Programming (for ASCII mode and Auto mode only)
This should be located at the beginning of the encoding data, e.g. data = "~rpABCD1234".
~m5: 05 Macro (for ASCII mode and Auto mode only)
This should be located at the beginning of the encoding data, e.g. data = "~m5ABCD1234".
~m6: 06 Macro (for ASCII mode and Auto mode only)
This should be located at the beginning of the encoding data, e.g. data = "~m6ABCD1234".

Property: Data Matrix Data Mode

Type: int

Default: AUTO

Data Matrix data encoding mode.

Valid values are:

AUTO (0): Barcode library will decide the best data mode for you. This is the default encoding format by Barcode Library.
ASCII (1): it is used to encode data that mainly contains ASCII characters (0-127).
C40 (2): it is used to encode data that mainly contains numeric and upper case characters.
TEXT (3): it is used to encode data that mainly contains numeric and lower case characters.
X12 (4):it is used to encode the standard ANSI X12 electronic data interchange characters.
EDIFACT (5): it is used to encode 63 ASCII values (values from 32 to 94) plus an Unlatch character (binary 011111).
BASE256 (6): it is used to encode 8 bit values.

Property: Data Matrix Format Mode

Type: int

Default: 10X10

Specifies the Data Matrix Format to use on that symbology. Valid values see options in the list;

Property: Data Matrix FNC1 Mode

Type: int

Default: NONE

To encode GS1 compatible Data Matrix barcode, you need set fnc1Mode value to "ENABLE".

Property: 2D Barcode Structured Append

Type: boolean
Default: false

Set Structured Append property to true, then Structured Append is enabled.

Property: 2D Barcode Symbol Count

Type: int
Default: 0

Set Symbol Count property to the number of total symbols which make the sequence.

Property: 2D Barcode Symbol Index

Type: int
Default: 0

Set Symbol Index property to the position of current symbol in the secuence (Start with 0).

Property: 2D Barcode File Id

Type: int
Default: 0

Set File Id property to be identified to the same file.

Barcode
Size
Related

Property: Unit of Measure

Type: int
Default: 0 (pixel)

Unit of meature for all size related settings in the library.
Valid values: 0: pixel; 1: inch; 2: cm.

Property: X

Type: float
Default: 1

Width of barcode bar module (narrow bar), default is 1 pixel

Property: Left Margin

Type: float
Default: 0

Barcode image left margin size.

Property: Right Margin

Type: float
Default: 0

Barcode image right margin size.

Property: Top Margin

Type: float
Default: 0

Barcode image top margin size.

Property: Bottom

Type: float
Default: 0

Barcode image bottom margin size.

Property: Resolution (in dpi)

Type: int
Default: 72

Barcode image resolution in DPI (Dots per inch).

Property: Rotate

Type: int
Default: 0 (rotate angle in 0 degree)

Valid values:

0 (rotate angle in 0 degree)
90 (rotate angle in 90 degree)
180 (rotate angle in 180 degree)
270 (rotate angle in 270 degree)

Data Matrix Data Encoding: Character Sets & Lengths

Data Matrix supports various character sets, data lengths, and encoding modes. All these settings are configured in the Report Item Property view of the Image Report Item, ensuring alignment with BIRT best practices.

Valid Character Sets

Data Matrix encodes multiple character sets, which you can configure in the Report Item Property view:

Full ASCII (0 - 127): Use DataMatrixDataMode.ASCII. This is the default encoding mode and works for most standard text data (e.g., URLs, plain text IDs) in BIRT reports.
Extended ASCII (128 - 255): Also supported via ASCII mode. Supports special characters such as accented letters, currency symbols, and punctuation marks, which are common in international BIRT reports.
International Characters (Arabic, Cyrillic, etc.): These can be supported by enabling the Extended Channel Interpretation (ECI) protocol in the Report Item Property view. The ECI protocol allows Data Matrix to encode non-ASCII character sets by specifying a character set identifier, which is critical for Locale/Internationalization in BIRT reports.

Maximum Data Length

The maximum data length of a Data Matrix depends on its encoding mode and error correction level. You can check these limits in the Report Item Property view's "Data Matrix" section, and use a Filter to ensure your data does not exceed the limit:

Capacity varies by encoding mode (Version 200):

Numeric data: Up to 3,116 digits.
Alphanumeric data: Up to 2,335 characters.
Byte data (8-bit): Up to 1,555 characters.

Note: Exceeding the maximum length for your selected mode will cause encoding errors. Use a Filter to validate data length before generation.

Data Matrix Encoding Data Modes

Data Matrix uses six primary encoding modes, which the generator can auto-select or you can manually set in the Report Item Property view. The "DataMode" property in the Report Item Property view controls this setting:

Available modes in Report Item Property:

DataMatrixDataMode.Auto: Automatic selection (recommended)
ASCII: For digits and standard ASCII
C40: For uppercase alphanumeric
Text: For lowercase alphanumeric
X12: For ANSI X12 EDI data
Edifact: For ASCII 32 - 94
Base256: For full byte values 0 - 255

Note: Manually selecting an incompatible encoding mode (e.g., ASCII Mode for Unicode text) will cause encoding errors. Always use Auto Mode if you're unsure about the data type, or verify the Data Set field's data type before selecting a mode.

Data Matrix Complex Text Encoding in BIRT reports

We'll walk you through encoding more complex data types in Data Matrix barcodes within BIRT reports, including ASCII non-printable characters, Unicode text, binary data, and GS1 data elements. All steps use the Report Item Property view and BIRT Scripting features.

Encode ASCII Non-Printable Characters

Some ASCII characters (e.g., Carriage Return [CR], Line Feed [LF], Tab) are non-printable and cannot be directly input in your Java code or BIRT Data Set.

Follow these steps to encode them:

Set ProcessTilde = true
Set DataMode = Base256
Encode characters as ~ddd (e.g., ~013 for CR). Example data value: Data~013Matrixs

Set the "Data" property using a BIRT Expression that includes the escaped non-printable characters. For example: "Data~013Matrix" (encodes "Data" + CR + "Matrix").

Note: Forgetting to set "ProcessTilde" to "true" will cause the tilde (~) to be treated as plain text, resulting in an invalid Data Matrix that cannot be scanned correctly.

Encode Unicode Text

Data Matrix can easily encode Unicode text (e.g., Chinese, Japanese, Arabic) in BIRT reports. Follow these steps to configure this in the Report Item Property view:

Set EncodeUnicodeText = true in Report Item Property
Bind Unicode data from your Data Set using Data Binding
The BIRT Event Handler converts text to UTF-8 bytes automatically

The barcode engine will render Unicode correctly in the final report.

Additional Supported Data Formats

Data Matrix supports additional data formats that are useful in enterprise BIRT reports. Configure these in the Report Item Property view and use BIRT Scripting for advanced logic:

Binary data
GS1-compliant data messages
Structured Append for large data

All configurations are managed in Report Item Property.

Data Matrix Dimension & Size Settings

Customize the size and dimensions of your Data Matrix barcodes in BIRT reports using the Report Item Property view. You can create square or rectangular Data Matrix barcodes, adjust module size, and set quiet zones to ensure scannability. All aligned with BIRT's layout features.

Fixed-Size Square Data Matrix

Set BarcodeWidth to your desired pixel size.
The height will automatically match the width (square format).

Rectangular Data Matrix (ECC200)

Data Matrix (ECC200) specifies 6 rectangular symbols, which you can generate in BIRT reports via the Report Item Property view:

8×18, 8×32, 12×26, 12×36, 16×36, 16×48

To create a rectangular barcode:

Set FormatMode to your preferred dimension (e.g., Format_16X48)
Set BarcodeWidth and BarcodeHeight with correct aspect ratio
Adjust margins in Report Item Property

Advanced Dimension Properties

For precise control over Data Matrix dimensions, use the advanced size settings in the Report Item Property view. You can fully customize barcode size:

UOM (Unit of Measure: PIXEL, CM, INCH)
X (module width)
LeftMargin, RightMargin, TopMargin, BottomMargin (quiet zones)
Resolution (for high-resolution printing)

Note: Quiet zone margins must be at least 1X. Scanners may fail to read barcodes with insufficient margins.

Data Matrix Color & Image Output Settings

Customize the color scheme and image output format of your Data Matrix barcodes in BIRT reports using the Report Item Property view. These settings ensure your Data Matrix barcodes are visible and compatible with different BIRT Output Formats (e.g., PDF, HTML, Excel, Word).

Data Matrix Colors

By default, Data Matrix uses a dark module color (black) and light background color (white). You can customize these colors in the Report Item Property view to align with your BIRT report's branding:

ForeColor: Module (bar) color
BackColor: Background color. Support transparent background color.
Support for dark-on-light and light-on-dark styles

Dark modules with light background

Light modules with dark background

Note: Transparent Background: Enable the "TransparentBackColor" property in the Report Item Property view to make the Data Matrix's background transparent. This is useful if the BIRT report has a custom background color or image (added via the Master Page).

Image Output Formats

Configure the image format and quality of your Data Matrix barcodes in the Report Item Property view to support different BIRT Output Formats.

BIRT supports multiple raster and vector formats:

PNG, JPEG, BMP
SVG

Select the format in the Image section of Report Item Property.

The BIRT Report Engine will render the barcode into the Report Document (.rptdocument) during runtime.

Note: SVG Vector format is not supported by all BIRT Output Formats. Test the report export to ensure the Data Matrix renders correctly in your target format (e.g., PDF, Word) before deployment.

Advanced Data Matrix Options

Take advantage of advanced Data Matrix features in BIRT reports, including Format Mode selection, Structured Append mode, and FNC1 for GS1 compliance. All these options are configured in the Report Item Property view, ensuring integration with BIRT's advanced reporting capabilities.

Format Mode (Symbol Size)

Data Matrix ISO standard specifies 24 square symbols and 6 rectangular symbols available in ECC 200. Each symbol size includes different rows and columns with different data storage capacity. Configure the Format Mode in the Report Item Property view:

Set FormatMode such as:

Format_20X20
Format_48X48
Format_16X48 (rectangle)

If data exceeds capacity, the engine auto-upgrades to a larger symbol.

Structured Append Mode

Structured Append mode allows you to split large data into multiple Data Matrix barcodes, which can be scanned in sequence to reconstruct the full data. This is useful for encoding large documents or datasets in BIRT reports (e.g., detailed product descriptions, batch information). Configure this mode in the Report Item Property view:

Enable in Report Item Property:

StructuredAppend = true
SymbolCount: total symbols
SymbolIndex: sequence number (starts at 0)
FileId: unique ID for all linked barcodes

This is often used in Table or List Report Items for batch data.

FNC1 First Position (GS1 Compliance)

When FNC1 (Function Code 1) is 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, retail, and healthcare BIRT reports. Configure this in the Report Item Property view:

Set FNC1 = FNC1_1ST_POS in Report Item Property

This marks the barcode as GS1-compatible for supply chain and industrial systems.

Summary

You now have a complete, step-by-step guide to generating Data Matrix barcodes in BIRT reports for Eclipse Java projects. All Data Matrix properties are configured in the Report Item Property view of the Image Report Item, ensuring consistency and ease of management across your BIRT reports.

Using OnBarcode Data Matrix Barcode BIRT Generator, you can customize Data Matrix encoding, size, color, and advanced features (Structured Append, FNC1) to meet your BIRT report's specific requirements, whether for supply chain, retail, or enterprise reporting.

Common Asked Questions

What is a data matrix code?

A data matrix code is a 2-dimensional code that is made of black and white cells that are usually arranged in a square pattern. Using BIRT barcode generator plugin, you can easily encode, create, customize and print Data Matrix barcodes in BIRT Report Designer property editor.

What is the ISO standard for Data Matrix?

Data Matrix ISO specification is ISO/IEC 16022, and the latest standard version is ISO/IEC 16022:2024. BIRT Barcode Generator plugin fully support ISO compatible Data Matrix generations in Eclipse BIRT reports.

What are the different types of Data Matrix?

According to Data Matrix latest ISO specification, there are two versions of Data Matrix

ECC 000-140
ECC 200.

OnBarcode BIRT barcode plugin fully supports Data Matrix ECC200, which uses the Reed-Solomon error correction, in BIRT report designer and report viewer.

How much data can a Data Matrix store?

It depends on the Data Matrix encoding data formats.

Alphanumeric data: up to 2,335 characters
Byte data (8-bit): 1,555 characters
Numeric data: 3,116 digits

If your encoding text size is over the maximum Data Matrix capacity, the birt report barcode plugin will through an exception or create an empty image with error message in report viewer.

What is the minimum and maximum size of Data Matrix barcode?

The minimum size of Data Matrix is 10 x 10 modules. And the maximum size of Data Matrix is 144 x 144 modules. OnBarcode BIRT Barcode generator plugin supports all formats defined in Data Matrix ISO standard. You can customize the Data Matrix format through BIRT Report Designer property editor.

Can a phone scan a Data Matrix?

Yes. You can scan a Data Matrix using your iPhone with your 3rd party app installed.

Is a Data Matrix the same as a QR Code?

No. They are not the same barcode symbologies. Data Matrix and QR Code have lot of same features. They are both 2d barcodes, and enable to encode ASCII text, Unicode text, binary data. Both of them are encoding GS1 business data messages. BIRT Barcode Generator plugin fully supports both Data Matrix and QR Code generations in BIRT reports in Java web and desktop applications.

In this page

Start with free trial package: