View source for Seam (BIRT) Recipe

= Set up environment =
== Get started with Seam ==
* [http://sourceforge.net/project/showfiles.php?group_id=22866&package_id=163777 Download] and [http://seamframework.org/Documentation/GettingStartedWithSeam install] seam (I tried it with jboss-seam-2.0.0.GA).
* Get started with [http://docs.jboss.com/seam/2.0.1.GA/reference/en/html/gettingstarted.html seam-gen], generate [http://docs.jboss.com/seam/2.0.1.GA/reference/en/html/gettingstarted.html#d0e2146 new project]. <code>build.properties</code> can look like this:
<source lang="text">
#Generated by seam setup
#Sun May 11 07:49:04 CEST 2008
hibernate.connection.password=
workspace.home=/home/user/projects
model.package=org.seambirt.sample.entity
driver.jar=lib/hsqldb.jar
action.package=org.seambirt.sample
test.package=org.seambirt.sample.test
database.type=hsql
richfaces.skin=deepMarine
hibernate.default_catalog.null=
hibernate.default_schema.null=
database.drop=n
project.name=seambirt
hibernate.connection.username=sa
hibernate.connection.driver_class=org.hsqldb.jdbcDriver
hibernate.cache.provider_class=org.hibernate.cache.HashtableCacheProvider
project.type=ear
icefaces.home=
database.exists=n
jboss.home=/opt/jboss-4.2.2.GA
hibernate.dialect=org.hibernate.dialect.HSQLDialect
hibernate.connection.url=jdbc\:hsqldb\:.
</source>

* Generate new entity (<code>$ seam new-entity</code>). I named it SampleReport.
* [OPTIONAL] Include Seam project into your IDE. Eclipse Users: Add the project
into Eclipse using File > New > Project and select General > Project (not Java
Project). NetBeans Users: Open the project in NetBeans.

== Get started with BIRT ==
* [http://www.eclipse.org/birt/phoenix/build/ Download BIRT (birt-runtime-2_2_1)]
* Copy jars below from <code>$BIRT_RUNTIME/WebViewerExample/WEB-INF/lib</code> to <code>$PROJECT/lib</code>
<source lang="bash">
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/com.ibm.icu_3.6.1.v20070906.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/commons-cli-1.0.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/coreapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/dataadapterapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/dteapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/engineapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/flute.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/chartengineapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/js.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/modelapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/modelodaapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/odadesignapi.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/org.apache.commons.codec_1.3.0.v200706111738.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/org.eclipse.emf.common_2.2.1.v200702131851.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/org.eclipse.emf.ecore.xmi_2.2.2.v200702131851.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/org.eclipse.emf.ecore_2.2.2.v200702131851.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/org.w3c.css.sac_1.3.0.v200706111724.jar $PROJECT/lib
cp $BIRT_RUNTIME/WebViewerExample/WEB-INF/lib/scriptapi.jar $PROJECT/lib
</source>
* Copy dir (include subdirs) from $BIRT_RUNTIME/WebViewerExample/WEB-INF/platform to $PROJECT/resources/WEB-INF/platform
<source lang="bash">
cp -r $BIRT_RUNTIME/WebViewerExample/WEB-INF/platform $PROJECT/resources/WEB-INF/platform
</source>

= Integrate =
== Change project defaults ==
* Change ant script <code> $PROJECT/build.xml</code> 
** Add property 
<source lang="xml">
<property name="birt.platform.dir" value="resources/WEB-INF/platform" />
</source>
** Change war target:
<source lang="xml">
...
<target name="war" depends="compile" description="Build the distribution .war file">             
...
    <copy todir="${war.dir}/WEB-INF/lib">
                        <fileset dir="${lib.dir}">
                                <include name="richfaces-impl*.jar" />
                                <include name="richfaces-ui*.jar" />
                                <include name="oscache*.jar" />
                                <include name="commons-digester.jar" />
                                <include name="commons-beanutils.jar" />
                                <include name="jsf-facelets.jar" />
                                <include name="jboss-seam-*.jar" />
                                <exclude name="jboss-seam-gen.jar" />
                                <!-- BIRT -->
                                <include name="com.ibm.icu_3.6.1.v20070906.jar" />
                                <include name="commons-cli-1.0.jar" />
                                <include name="coreapi.jar" />
                                <include name="dataadapterapi.jar" />
                                <include name="dteapi.jar" />
                                <include name="engineapi.jar" />
                                <include name="flute.jar" />
                                <include name="chartengineapi.jar" />
                                <include name="js.jar" />
                                <include name="modelapi.jar" />
                                <include name="modelodaapi.jar" />
                                <include name="odadesignapi.jar" />
                                <include name="org.apache.commons.codec_1.3.0.v200706111738.jar" />
                                <include name="org.eclipse.emf.common_2.2.1.v200702131851.jar" />
                                <include name="org.eclipse.emf.ecore.xmi_2.2.2.v200702131851.jar" />
                                <include name="org.eclipse.emf.ecore_2.2.2.v200702131851.jar" />
                                <include name="org.w3c.css.sac_1.3.0.v200706111724.jar" />
                                <include name="scriptapi.jar" />
                        </fileset>
                </copy>
                <copy todir="${war.dir}/WEB-INF/platform/">
                        <fileset dir="${birt.platform.dir}" />
                </copy>
</source>

build.xml all in one: [[Seam (BIRT) Recipe - $PROJECT/build.xml]]

== Code Seam-BIRT servlet ==
* Make two new classes in the project (e.g. in <code>$PROJECT/src/action</code> dir)
** org.jboss.seam.pdf.birt.BirtEngine - see [[Seam (BIRT) Recipe - BirtEngine]]
** org.jboss.seam.pdf.birt.DocumentStoreServlet - see [[Seam (BIRT) Recipe - DocumentStoreServlet]]

* Add BIRT pdf servlet to $PROJECT/resources/WEB-INF/web.xml .
<source lang="xml">
....
  <!--  BIRT PDF servlet -->
   <servlet>
        <servlet-name>Document Store Servlet</servlet-name>
        <servlet-class>org.jboss.seam.pdf.birt.DocumentStoreServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>Document Store Servlet</servlet-name>
        <url-pattern>*.pdf</url-pattern>
    </servlet-mapping>
...
</source>

== Make BIRT report ==
* make <code>$PROJECT/view/sample.xhtml</code> report (rptdesign)
Instantiate Seam component by
<source lang="xml">
...
            <method name="open"><![CDATA[var reports = Packages.org.jboss.seam.Component.getInstance("sampleReportList", true);
            reportsIterator = reports.getResultList().listIterator();]]></method>
...
</source>
sample.xhtml all in one: [[Seam (BIRT) Recipe - Sample Report]]

** Add create report button to <code>$PROJECT/view/sampleReportList.xhtml</code> [[Seam (BIRT) Recipe - sampleReportList.xhtml]]
<source lang="xml">
...
<div class="actionButtons">
        <s:button id="done" 
               value="Create sampleReport"
                view="/sampleReport.xhtml"/>	
        <s:button id="report" value="Report" view="/sample.pdf?ReportName=report.rptdesign" />		  
</div>
...
</source>

== Bon appetit ==
* Run <code>ant explode</code>, start jBoss app. server
* Cook in oven about 40 minutes & visit [http://localhost:8080/seambirt restaurant] :-)

----
[[Image:seambirt-seam.png|frame|Seam app UI]]
[[Image:seambirt-birt.png|frame|Seam component in BIRT]]