README

Last Updated: June 20, 2007

This document describes how to generate a web viewer which can work in Standalone Tomcat from BIRT 2.2 source code.

Table of Contents
¡¡

Description
Prerequisites
Setup
¡¡

Description

Ant script WebViewerPackager.xml under org.eclipse.birt.report.viewer can be used to help building web viewer.
The web viewer depends on BIRT releng tools org.eclipse.birt.releng.birtbuilder.
Api jar under WEB-INF/lib will be generated during the process of running org.eclipse.birt.releng.birtbuilder.

Please refer to Readme.html under project org.eclipse.birt.releng.birtbuilder first.
¡¡

Prerequisites

1. Install Eclipse platform/GEF/EMF/DTP projects

2. Download Obit release( http://download.eclipse.org/tools/orbit/downloads ) and extract following bundles to the plugins folder of eclipse home:
org.apache.batik.bridge
org.apache.batik.css
org.apache.batik.dom
org.apache.batik.dom.svg
org.apache.batik.ext.awt
org.apache.batik.extension
org.apache.batik.parser
org.apache.batik.pdf
org.apache.batik.svggen
org.apache.batik.swing
org.apache.batik.transcoder
org.apache.batik.util
org.apache.batik.util.gui
org.apache.batik.xml
org.apache.xml.resolver
org.apache.xerces
org.w3c.css.sac
org.w3c.dom.svg
org.w3c.dom.smil
¡¡

Setup
¡¡

1. Download project org.eclipse.birt.releng.birtbuilder. Follow the steps in Readme.html under it to create birt-report-framework package. The api jars will be created in this process which are needed by following steps.
After the build finished, extract the generated birt-report-framework-*.zip and birt-third-party*.zip to directory <integrated.dir>

Note: BIRT source code do not need to be checked out manually. They will be checked out during build process of org.eclipse.birt.releng.birtbuilder.
And users can import projects <buildDirectory>/plugins into workspace for modification directly. The rerun of the build won't overwrite the changes made in the <buildDirectory>/plugins.

2. Switch to the <buildDirectory>/plugins/org.eclipse.birt.report.viewer directory. <buildDirectory> is the working dir of Step 1.

Use Ant Build to call Jar target in WebViewerPackager.xml to create web viewer framework:
ant -f WebViewerPackager.xml Jar -DbaseLocation=<eclipse home> -Dintegrated.dir=<integrated.dir>
When build is successful, birt_web is created under root of viewer plugin, and web viewer framework is put under birt_web.

Make sure following property have been set value when running from ant:
baseLocation - set to the directory where prerequisites Eclipse platform locates
integrated.dir - set to the directory where birt bundles generated in step1 are locales
¡¡