Jump to: navigation, search

Difference between revisions of "Birt 3.7 Migration Guide"

(New page: {{Backlink|BIRT Project}} __TOC__ ==BIRT POJO Runtime== ==BIRT POJO Viewer Deployment== ==BIRT 3.7 API Changes== BIRT POJO Runtime The new BIRT Runtime consists of a set of jars that can...)
 
Line 1: Line 1:
 
{{Backlink|BIRT Project}}
 
{{Backlink|BIRT Project}}
 +
 
__TOC__
 
__TOC__
 +
 
==BIRT POJO Runtime==
 
==BIRT POJO Runtime==
 +
BIRT 3.7 features a new POJO based runtime.
 +
The new Runtime consists of a set of jars that can simply be added to the classpath of your application.  While this affects the Runtime of BIRT the designer will continue to use the same OSGi based approach as previous versions of BIRT.  The new Runtime is available for download on the BIRT web site and is structured as illustrated in the following diagram.
 +
[[Image:BIRTPOJOruntime.png]]
 +
 +
The Runtime contains the ReportEngine which can be used to run and render reports using the Report Engine API (RE API), and the DesignEngine which can be used to create report, library and template designs using the Design Engine API (DE API).  The Runtime also contains the Chart Engine which can be used to build and display charts outside of a BIRT report or to manipulate charts within a design using the Chart Engine API (CE API). 
 +
 +
The ReportEngine directory also contains a bat file (genReport.bat) or shell script (genReport.sh) to run reports from the command line using the Report Engine API.
 +
 
==BIRT POJO Viewer Deployment==
 
==BIRT POJO Viewer Deployment==
 
==BIRT 3.7 API Changes==
 
==BIRT 3.7 API Changes==
 +
If you have existing code (RE, DE or CE API) that you plan on migrating to BIRT 3.7, no changes should be required, but it is advised to remove the setBirtHome method from your EngineConfig instance. 
 +
 +
BIRT RE API code
 +
config = new EngineConfig( );
 +
config.setBIRTHome("pathtoruntime");
 +
Should be changed to:
 +
config = new EngineConfig( );
  
 +
BIRT DE API code
 +
config = new DeisgnConfig( );
 +
config.setBIRTHome("pathtoruntime");
 +
Should be changed to:
 +
config = new DesignConfig( );
  
BIRT POJO Runtime
+
If you are using the Chart Engine API
The new BIRT Runtime consists of a set of jars that can simply be added to the classpath of your applicationWhile this affects the Runtime of BIRT the designer will continue to use the same approach as previous versions of BIRT. The new Runtime is available for download on the BIRT web site and is structured as illustrated in the following diagram.
+
PlatformConfig pf = new PlatformConfig();
 +
pf.setBIRTHome("pathtoruntime");
 +
  Should be changed to:
 +
  PlatformConfig pf = new PlatformConfig();

Revision as of 12:25, 16 June 2011

< To: BIRT Project

BIRT POJO Runtime

BIRT 3.7 features a new POJO based runtime. The new Runtime consists of a set of jars that can simply be added to the classpath of your application. While this affects the Runtime of BIRT the designer will continue to use the same OSGi based approach as previous versions of BIRT. The new Runtime is available for download on the BIRT web site and is structured as illustrated in the following diagram. BIRTPOJOruntime.png

The Runtime contains the ReportEngine which can be used to run and render reports using the Report Engine API (RE API), and the DesignEngine which can be used to create report, library and template designs using the Design Engine API (DE API). The Runtime also contains the Chart Engine which can be used to build and display charts outside of a BIRT report or to manipulate charts within a design using the Chart Engine API (CE API).

The ReportEngine directory also contains a bat file (genReport.bat) or shell script (genReport.sh) to run reports from the command line using the Report Engine API.

BIRT POJO Viewer Deployment

BIRT 3.7 API Changes

If you have existing code (RE, DE or CE API) that you plan on migrating to BIRT 3.7, no changes should be required, but it is advised to remove the setBirtHome method from your EngineConfig instance.

BIRT RE API code
config = new EngineConfig( ); 
config.setBIRTHome("pathtoruntime");
Should be changed to:
config = new EngineConfig( ); 
BIRT DE API code
config = new DeisgnConfig( );
config.setBIRTHome("pathtoruntime");
Should be changed to:
config = new DesignConfig( );
If you are using the Chart Engine API
PlatformConfig pf = new PlatformConfig();
pf.setBIRTHome("pathtoruntime");
Should be changed to:
PlatformConfig pf = new PlatformConfig();