Author: mcaspers Date: 2011-03-07 18:29:40 -0500 (Mon, 07 Mar 2011) New Revision: 29589 Modified: trunk/birt/docs/en-US/birt_integration_with_seam.xml Log: "General editing and screenshot updates" Modified: trunk/birt/docs/en-US/birt_integration_with_seam.xml =================================================================== --- trunk/birt/docs/en-US/birt_integration_with_seam.xml 2011-03-07 23:26:09 UTC (rev 29588) +++ trunk/birt/docs/en-US/birt_integration_with_seam.xml 2011-03-07 23:29:40 UTC (rev 29589) @@ -1,39 +1,51 @@ <?xml version='1.0' encoding='UTF-8'?> <section id="birt_integration_with_seam"> <title>Adding BIRT Functionality to Standard Seam Web Project</title> - + <para>This section discusses the process of integrating BIRT into a Seam web project. </para> - + <para> To follow this guide you will need to have the Seam runtime and JBoss Application Server downloaded and extracted on your hard drive. You can download Seam from the <ulink url="http://seamframework.org/Download">Seam Framework</ulink> web page and JBoss Application Server from <ulink url="http://jboss.org/jbossas/downloads/">JBoss Application Server</ulink> official site. </para> - + <note> <title>Tip:</title> <para> <ulink url="http://sourceforge.net/projects/jboss/files/JBoss%20Seam/2.2.1.... Seam 2.2.1 GA</ulink> and <ulink url="http://sourceforge.net/projects/jboss/files/JBoss/JBoss-5.1.0.G... Application Server 5.1.0 GA</ulink> were used in the examples presented in this guide. </para> </note> - + <section id="creatin_project_with_birt"> <title>Creating Seam Web Project with Birt Facet</title> - + <para> - It is recommended that you open the Seam Perspective by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Seam</guimenuitem></menuchoice>. This perspective provides conventient access to all the Seam tools. + It is recommended that you open the Seam Perspective by selecting <menuchoice><guimenuitem>Window</guimenuitem> + <guimenuitem>Open Perspective</guimenuitem> + <guimenuitem>Other</guimenuitem> + <guimenuitem>Seam</guimenuitem> + </menuchoice>. This perspective provides conventient access to all the Seam tools. </para> <para> - To create a new Seam Web project select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice>. If the Seam Perspective is not active, select - <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice>. + To create a new Seam Web project select <menuchoice><guimenuitem>File</guimenuitem> + <guimenuitem>New</guimenuitem> + <guimenuitem>Seam Web Project</guimenuitem> + </menuchoice>. If the Seam Perspective is not active, select + <menuchoice><guimenuitem>File</guimenuitem> + <guimenuitem>New</guimenuitem> + <guimenuitem>Other</guimenuitem> + <guimenuitem>Seam</guimenuitem> + <guimenuitem>Seam Web Project</guimenuitem> + </menuchoice>. </para> - + <orderedlist> - + <listitem> - <para>On the first wizard page enter the project name, then specify the target runtime and - target server. We recommend to use JBoss AS server and runtime environment to ensure best performance. - </para> - + <para> + On the first wizard page enter the <guilabel>Project name</guilabel>, specify the <guilabel>Target runtime</guilabel> and <guilabel>Target server</guilabel>. We recommend to use the JBoss AS server and runtime environment to ensure best performance. + </para> + <figure id="CreatingSeamWebProject"> <title>Creating Seam Web Project</title> <mediaobject> @@ -44,18 +56,15 @@ </figure> </listitem> <listitem> - <para>In the <emphasis><property>Configuration</property> - </emphasis> group choose the version of <emphasis> - <property>Seam</property> - </emphasis> framework you are planning to use in your application. In this guide we used Seam 2.2. </para> + <para> + In the <guilabel>Configuration</guilabel> group select the <productname>Seam</productname> framework version you are planning to use in your application. In this guide we used Seam 2.2. + </para> </listitem> <listitem> - <para>Click the <emphasis><property>Modify</property> - </emphasis> button - and enable the <emphasis> - <property>Birt Reporting Runtime Component</property> - </emphasis> facet by checking the appropriate option.</para> - + <para> + Click the <guibutton>Modify</guibutton> button and enable the <guilabel>Birt Reporting Runtime Component</guilabel> facet by checking the appropriate option. + </para> + <figure> <title>Adding the Birt Reporting Runtime Component Facet </title> <mediaobject> @@ -64,11 +73,10 @@ </imageobject> </mediaobject> </figure> - <para>Alternatively you can just choose the <emphasis> - <property>JBoss BIRT Integration Web Project</property> - </emphasis> configuration from the drop-down list in the <emphasis><property>Configuration</property> - </emphasis> group </para> - + <para> + Alternatively you can select the <guilabel>JBoss BIRT Integration Web Project</guilabel> configuration option from the drop-down list in the <guilabel>Configuration</guilabel> group. + </para> + <figure> <title>Choosing the JBoss BIRT Integration Web Project Configuration</title> <mediaobject> @@ -77,22 +85,21 @@ </imageobject> </mediaobject> </figure> - + </listitem> - + <listitem> - <para>You may leave the next two pages with default values, just press <emphasis><property>Next</property> - </emphasis> to proceed. + <para>You may leave the next two pages with default values; just click the <guibutton>Next</guibutton> button to proceed. </para> </listitem> - + <listitem> - - <para>On the <emphasis><property>Birt Configuration</property> - </emphasis> page you can modify the BIRT deployment settings, which you can edit afterwards in the web.xml of the generated project. Let's keep the default values for now. - </para> - + + <para> + On the <guilabel>Birt Configuration</guilabel> page you can modify the BIRT deployment settings. These settings can also be edited afterwards in the <filename>web.xml</filename> file included in the generated project. Keep the default values for now. + </para> + <figure> <title>Configuring BIRT Deployment Settings</title> <mediaobject> @@ -102,23 +109,25 @@ </mediaobject> </figure> - + </listitem> - + <listitem> - <para>You can also leave the <emphasis><property>JSF Capabilities</property> - </emphasis> page with default values. </para> + <para>You can also leave the default options on the <guilabel>JSF Capabilities</guilabel> page.</para> </listitem> - + <listitem> - <para>On the <emphasis> - <property>Seam Facet</property> - </emphasis> page you should specify the Seam runtime and Connection profile. Please note, that the Seam runtime must be of the version you initially specified in the project settings (See the <link linkend="CreatingSeamWebProject">Creating Seam Web Project</link> figure). </para> - <para> When creating a Seam project with BIRT capabilities you can use the <property>BIRT Classic Models Sample Database</property> connection profile to work with the BIRT sample database.</para> - - <para>For more details on how to configure database connection for a Seam project please read the - <ulink url="http://docs.jboss.org/tools/3.0.0.GA/en/seam/html_single/index.... Seam Facet Settings</ulink> chapter of Seam Dev Tools Reference Guide.</para> + <para> + On the <guilabel>Seam Facet</guilabel> page you should specify the Seam runtime and Connection profile. Please note that the Seam runtime must be the same version you initially specified in the project settings (See <xref linkend="CreatingSeamWebProject"/>). + </para> + <para> + When creating a Seam project with BIRT capabilities you can use the <guilabel>BIRT Classic Models Sample Database</guilabel> connection profile to work with the BIRT sample database. + </para> + + <para> + For more details on how to configure database connection for a Seam project please read the <ulink url="http://docs.jboss.org/tools/3.2.0.GA/en/seam/html_single/index.... Seam Facet Settings</ulink> chapter of Seam Dev Tools Reference Guide. + </para> <figure> <title>Configuring the Seam Facet settings</title> <mediaobject> @@ -126,27 +135,24 @@ <imagedata fileref="images/birt_integration_with_seam/seamFacet.png"/> </imageobject> </mediaobject> - </figure> - + </figure> </listitem> - + <listitem> - <para>Hit <emphasis> - <property>Finish</property> - </emphasis> to create the project with BIRT functionality enabled.</para> + <para>Click the <guibutton>Finish</guibutton> button to create the project with BIRT functionality enabled.</para> </listitem> </orderedlist> </section> - + <section id="integration"> <title>Integration with Seam</title> <para> In the previous section you have created a Seam project with BIRT capabilities. Now you can create a simple kick start project to see that everything is configured correctly. </para> - + <orderedlist> <listitem> <para>Now create a BIRT report file and insert test data into the file. @@ -161,51 +167,51 @@ </para> <para>You can download the file <property>helloBirt.rptdesign</property> <ulink url="files/helloBirt.rptdesign">here</ulink> and copy it to the WebContent folder of your Seam project.</para> - + </listitem> - + <listitem> <para> When you are done with the <property>helloBirt.rptdesign</property> file, you should create a <property>.xhtml</property> file that will contain the BIRT report you have just created. </para> - + <para> The JBoss BIRT Integration framework provides 2 components represented as <emphasis role="bold"> <property>&lt;b:birt&gt;</property> </emphasis> and <emphasis role="bold"> <property>&lt;b:param&gt;</property> </emphasis> tags. The jboss-seam-birt.jar library implements the functionality of the components. To find more information about the framework pleas read the <link linkend="framework">JBoss BIRT Integraion Framework API Reference</link> chapter. To use that tags on the page you need to declare the tag library and define the name space like this: </para> - + <programlisting role="XML"><![CDATA[ xmlns:b="http://jboss.com/products/seam/birt" ]]></programlisting> - + <para> The <emphasis role="bold"> <property>&lt;b:birt&gt;</property> </emphasis> is a container for a BIRT report, that helps you integrate the report into Seam environment. You can manage the properties of the report using the attributes of the <emphasis role="bold"> <property>&lt;b:birt&gt;</property> </emphasis> tag. </para> - + <para> The <emphasis role="bold"> <property>&lt;b:param&gt;</property> </emphasis> tag describes report parameters. To set a parameter you need to specify it's name the value you want to pass. You can use EL expressions to bind the representation layer with back-end logic. </para> - + </listitem> - + <listitem> - + <para>Create the <property>helloBirt.xhtml</property> file in the WebContent with the following content: </para> - + <programlisting role="XML"><![CDATA[... <!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> @@ -225,20 +231,20 @@ </ui:define> </ui:composition> ...]]></programlisting> - + <para>From this listing above you see that the title of the report is set via <emphasis role="bold"> <property>&lt;b:param&gt;</property> </emphasis> by setting the parameter name and defining the <emphasis><property>&quot;value&quot;</property> </emphasis> attribute with the &quot;Customers Contacts&quot; value.</para> - + </listitem> - + <listitem> <para>We have created a Seam project and inserted the <property>helloBirt</property> report into the <property>helloBirt.xhtml</property> view file.</para> - + <para>To see that the application works correctly and as you expect, you need to launch it on the server.</para> </listitem> <listitem> @@ -246,8 +252,8 @@ </listitem> <listitem> <para>When the server is started, open your favourite browser and point it to <code>http://localhost:8080/HelloBirt/helloBirt.seam</code> .</para> - + <figure> <title>Integrating BIRT into Seam Project</title> <mediaobject> @@ -258,6 +264,6 @@ </figure> </listitem> </orderedlist> - + </section> </section> \ No newline at end of file