Skip to content

axonivy/birt-reporting

Axon.ivy BIRT extension

Provides BIRT report generation activities for the Axon.ivy Designer and allows it's execution on the Axon.ivy Engine.

Documentation

Installation

The installation procedure is exactly the same for Axon.ivy Designer and Engine. Therefore we're refer them as generic Axon.ivy product here.

  1. Download the BIRT extension that matches your Axon.ivy product from our releases into the dropins directory of your Axon.ivy product.
  2. Download the corresponding birt-runtime-osgi. Unpack the ZIP into a new system/lib/birtRuntime directory within the Axon.ivy product.
  3. Create the configuration/extensions/birt.properties file. Within you have to set the birtRuntime property so that it references your unpacked runtime libraries. E.g. engineHome=system/lib/birtRuntime/ReportEngine/platform

Versions

Since ivy 8.0 not supported anymore. Use doc-factory to create reports.

Axon.ivy Birt Extension Birt Runtime Engine Home
>=7.4 7.4 4.8.0 engineHome=system/lib/birtRuntime/birt-runtime-osgi-4_8_0/ReportEngine/platform
6.7 .. 7.3 6.7 4.2.2 engineHome=system/lib/birtRuntime/birt-runtime-osgi-4_2_2/ReportEngine
6.6 6.6 4.2.2 engineHome=system/lib/birtRuntime/birt-runtime-osgi-4_2_2/ReportEngine
<= 6.5 6.0 4.2.2 engineHome=system/lib/birtRuntime/birt-runtime-osgi-4_2_2/ReportEngine

Design a report

To design reports you can choose one of these tools:

  • RCP Designer (recommended): a dedicated tool for designing reports. Download s
  • Eclipse IDE for Java and Report Developers: a standalone reporting tool which contains also the full Eclipse SDK. Download
  • BIRT Framework Plugin for Eclipse Download Plugin to design reports directly in the Axon.ivy Designer. Just download and unzip it to the designer directory (skip already existing files).

Integrate Databases

All database drivers (e.g. the mysql-connector.jar for MySql) used in the report must be placed in the JDBC folder of the report engine. E.g. system/lib/birtRuntime/birt-runtime-osgi-4_2_2/ReportEngine/plugins/org.eclipse.birt.report.data.oda.jdbc_4.2.2.v201212061427/drivers/

Legacy

An outdated documentation is available. Some parts of it are no longer valid for the latest version. birtExtension/techdoc/IvyBirtPluginGuide_en.pdf