Engine classes

EngineConfig

is used to set global options for the report engine and to specify the location of the engine plug-ins and data drivers.

ReportEngine

represents the BIRT Report Engine.

The report engine is created through a factory supplied by the platform. Before creating the engine, you should start the platform. It will load the required plug-ins.

You can find more information here.

IReportRunnable

is used to handle IReportRunnable instances.

BIRT report designs are stored as .rptdesign files.

To work with the report design in the engine, you need to load the report using one of the openDesign() methods in the ReportEngine class.

These methods return a IReportRunnable instance representing the engine's view of the report design.

IEngineTask

provides the framework to manage scripting context, report locales, etc.

E.g., if an operation requires a script context or a locale, a task class will represent the operation. It means that opening a design file or retrieving an image in the design file does not require setting up a scripting context.

Other operations, such as retrieving default parameters or a dynamic selection list, running and rendering a report, etc., require a scripting context and are represented as tasks.

Tasks are created using the factory methods on the ReportEngine class.

You can use one of these tasks:

engine.createDataExtractionTask();

engine.createGetParameterDefinitionTask();

engine.createRenderTask();

engine.createRunTask();

engine.createRunAndRenderTask().

You can find more information here.

IRunTask

allows running reports and generating report documents.

Report documents are saved to the disk and can then be used with the IRenderTask to support features such as paging.

IRunAndRenderTask

allows running a report and publishing it with one of the supported output formats.

The IRunAndRenderTask class includes the validateParameters() method used to validate parameter values before you run the report.

You can find more information about Web Viewer Settings, Parameters, Directory Structure and Tag Library here.