To meet your needs, we constantly work to improve Querix products.
This means that Lycia documentation is developing as well.
In case you have found a certain dissonance between the provided information and the actual behavior of Lycia 3 and/or your applications, please, let us know about this via documentation@querix.com so that we can introduce the necessary changes to our documentation.
Thank you for your attention and cooperation.
BIRT provides a complete set of JavaScript objects to access the Report Object Model: a representation of both the design and runtime aspects of a report, allowing complete control of the report to handle even the most complex report formatting tasks.
The class in used to set global options for the report engine and to specify the location of engine plug-ins, data drivers. You can also use it to add application-wide scriptable objects.
EngineConfig config = new EngineConfig();
config.setEngineHome( "put engine path here" );
setLogConfig('String directoryName, Level level;)
This call sets the Log directory name and level (OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST and ALL)
Setting directoryName to null will log to stdout.
The class represents the BIRT Report Engine. The report engine is created through a factory supplied by the Platform. Thus, before creating the engine, you should start the Platform. It will load the required plug-ins. To do it, you will need to call Platform .startup(config) function that takes an EngineConfig object as argument. After using the engine, call Platform.shutdown() to do clean-up, including unloading the extensions.
Each application should create just one ReportEngine instance and use to run multiple reports. Remember it while deploying the engine in a servlet as well.
As it was already mentioned, BIRT report designs are stored as XML files with the .rptdesign extension. To work with the report design in the engine, you need 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.
BIRT Engine tasks provide the framework for managing the scripting context, report locales and so on. For instance, 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 required 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.
Create tasks using the factory methods on the ReportEngine class. The supported Tasks are shown below:
engine.createDataExtractionTask();
engine.createGetParameterDefinitionTask();
engine.createRenderTask();
engine.createRunTask();
engine.createRunAndRenderTask();
The detailed overview of these functions can be found in here:
http://www.eclipse.org/birt/phoenix/deploy/reportEngineAPI.php#api
Use this task to run a report and generate a report document, which is saved to disk. The report document can then be used with the IRenderTask to support features such as paging.
The task is used to run a report and output it to one of the supported output formats. IRunAndRenderTask does not create a report document which means you will need to create a new task for each report that you run. Reports may take different parameters, the default parameters values and the ones you can individually. The IRunAndRenderTask provides the validateParameters() method to validate the parameter values before you run the report.
The information regarding Web Viewer Settings, Parameters, Directory Structure and Tag Library is provided on Eclipse website, in the corresponding Chapter:
http://www.eclipse.org/birt/phoenix/deploy/viewerUsageMain.php