| "The output format html is not supported" Problem [message #58575] |
Thu, 14 July 2005 19:00 |
Eclipse User |
|
|
|
A number of posts have appeared from application developers who encounter
the message, "The output format html is not supported". This message is a
symptom of an incorrect environment, normally caused either by an
incorrectly set engine home or by mismatched source code and engine home
contents.
I am in the process of enhancing the documentation to include the following
information, which covers source code and plug-in compatibility and how to
find the engine home in the run-time BIRT. This information is not yet in
the build. The aim of this information is to avoid this type of problem.
Two extracts from the enhanced documentation follow. Unfortunately, the news
reader doesn't support formatting, so I've tried to make headings, steps,
and bullets as clear as possible within these limitations.
About the environment for a reporting application
=================================================
You must ensure that the deployed application can access all the classes
required for BIRT, your data sources, and any other classes you need. The
key requirement for BIRT is the location of the engine home. The engine home
contains the BIRT plug-ins and libraries needed to generate a report from a
report design. The version of the BIRT source code that your application
uses must match the version of the plug-ins and libraries in the BIRT engine
home directory. If these versions are not the same, your reporting
application is likely to fail.
The BIRT run-time library provides the complete environment for the
reporting application. This library is available as an archive (.zip) file
from the location from which you installed BIRT Report Designer and SDK. The
Report Engine directory of the BIRT run-time library contains all the
required plug-ins and libraries for the engine home.
The org.eclipse.birt.report.viewer plug-in also provides an example engine
home in its birt\WEB-INF subdirectory.
How to set up a BIRT engine home
================================
To set up a BIRT engine home, you must have access to the BIRT run-time
library archive (.zip) file. You can find this file in the location from
which you installed BIRT Report Designer and SDK. The name of the file is
birt-runtime-<version>.zip.
1. Open birt-runtime-<version>.zip.
2. Extract the contents of birt-runtime-<version>.zip to a suitable
location, such as C:\Program Files in a Microsoft Windows environment.
The BIRT engine home is the Report Engine subdirectory in the
birt-runtime-<version> directory.
3. Close birt-runtime-<version>.zip.
I have also expanded the information about how to set up the engine home:
How to set up a report engine
=============================
The following code shows an example of setting up a report engine. The
application uses the engine home located in the BIRT run-time directory. The
report output format is HTML. The application configures the HTML emitter,
then creates the engine with completed EngineConfig object.
1. Create an EngineConfig object.
EngineConfig config = new EngineConfig( );
2. To define the location of the engine home, use one of the following
techniques:
* Call setEngineHome( ) with an argument that is the path to your engine
home directory.
config.setEngineHome(
"C:/Program Files/birt-runtime-1_0/Report Engine" );
* In your application's environment, set the BIRT_HOME environment variable
and set your CLASSPATH to access the required libraries. For example, in a
command window, type commands similar to the following before launching your
application:
set BIRT_HOME="C:\Program Files\birt-runtime-1_0\Report Engine"
SET CLASSPATH=%BIRT_HOME%\Report Engine\core.jar;%BIRT_HOME%\Report
Engine\dte.jar;%BIRT_HOME%\Report Engine\js.jar;%BIRT_HOME%\Report
Engine\model.jar;%BIRT_HOME%\Report Engine\oda.jar;%BIRT_HOME%\Report
Engine\Tidy.jar;%BIRT_HOME%\Report Engine\engine.jar;%BIRT_HOME%\Report
Engine\chart-engine.jar;%BIRT_HOME%\Report
Engine\ecore.xmi.jar;%BIRT_HOME%\Report Engine\ecore.jar;%BIRT_HOME%\Report
Engine\ecore.resources.jar;%BIRT_HOME%\Report Engine\common.jar;%CLASSPATH%
* In Eclipse, perform the following steps:
Choose Run->Run...
Run-Main appears.
In Run, choose Arguments.
In VM arguments, type text similar to the following:
-DBIRT_HOME="C:\Program Files\birt-runtime-1_0\Report Engine"
3. Set up the configuration to write images or charts embedded in HTML
output.
HTMLEmitterConfig hc = new HTMLEmitterConfig( );
HTMLCompleteImageHandler imageHandler = new
HTMLCompleteImageHandler( );
hc.setImageHandler( imageHandler );
config.setEmitterConfiguration(
HTMLRenderOption.OUTPUT_FORMAT_HTML, hc );
4. Create the engine.
ReportEngine engine = new ReportEngine( config );
--
Jane Tatchell
BIRT documentation lead
|
|
|
Powered by
FUDForum. Page generated in 0.06094 seconds
Home