From jbosstools-commits at lists.jboss.org Mon Mar 7 18:29:41 2011 Content-Type: multipart/mixed; boundary="===============1839267554724498140==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r29589 - trunk/birt/docs/en-US. Date: Mon, 07 Mar 2011 18:29:40 -0500 Message-ID: <201103072329.p27NTeRB020870@svn01.web.mwc.hst.phx2.redhat.com> --===============1839267554724498140== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/birt/docs/en-US/birt_integration_with_seam.xml 2011-03-07 23:26:0= 9 UTC (rev 29588) +++ trunk/birt/docs/en-US/birt_integration_with_seam.xml 2011-03-07 23:29:4= 0 UTC (rev 29589) @@ -1,39 +1,51 @@
Adding BIRT Functionality to Standard Seam Web Project - + = This section discusses the process of integrating BIRT into a Seam = web project. - + = To follow this guide you will need to have the Seam runtime and JBos= s Application Server downloaded and extracted on your hard drive. You can d= ownload Seam from the Seam= Framework web page and JBoss Application Server from JBoss Application Server offi= cial site. = - + = Tip: JBoss Seam 2.2.1 GA and JBoss Application Serve= r 5.1.0 GA were used in the examples presented in this guide. - + =
Creating Seam Web Project with Birt Facet - + = - It is recommended that you open the Seam Perspective by selecting WindowOpen PerspectiveOtherSeam. This perspective provides conventient access to all the Seam too= ls. = + It is recommended that you open the Seam Perspective by selecting Window + Open Perspective + Other + Seam + . This perspective provides conventient access to all the = Seam tools. = - To create a new Seam Web project select FileNewSeam Web Project. If the Seam Perspective is not active, select = - FileNewOtherSeamSeam Web Project. + To create a new Seam Web project select File + New + Seam Web Project + . If the Seam Perspective is not active, select = + File + New + Other + Seam + Seam Web Project + . - + = - + = - On the first wizard page enter the project name, then specify th= e target runtime and - target server. We recommend to use JBoss AS server and runtime= environment to ensure best performance. - - = + + On the first wizard page enter the Project name,= specify the Target runtime and Target serve= r. We recommend to use the JBoss AS server and runtime environme= nt to ensure best performance. + = + =
Creating Seam Web Project @@ -44,18 +56,15 @@
- In the Configuration - group choose the version of - Seam - framework you are planning to use in your application. In= this guide we used Seam 2.2. + + In the Configuration group select the Seam framework version you are planning to use in your app= lication. In this guide we used Seam 2.2. = + - Click the Modify - button - and enable the - Birt Reporting Runtime Component - facet by checking the appropriate option. - + + Click the Modify button and enable the Birt Reporting Runtime Component facet by checking the approp= riate option. + + =
Adding the Birt Reporting Runtime Component Facet @@ -64,11 +73,10 @@
- Alternatively you can just choose the - JBoss BIRT Integration Web Project - configuration from the drop-down list in the Configuration - group - + + Alternatively you can select the JBoss BIRT Integration Web= Project configuration option from the drop-down list in the Configuration group. + + =
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 y= ou 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 th= e BIRT deployment settings. These settings can also be edited afterwards in= the <filename>web.xml</filename> file included in the generated project. K= eep the default values for now. + </para> + = <figure> <title>Configuring BIRT Deployment Settings @@ -102,23 +109,25 @@
= - = = + = - + = - You can also leave the JSF Capabilities - page with default values. + You can also leave the default options on the JSF Capa= bilities page. - + = - On the - Seam Facet - page you should specify the Seam runtime and Connection p= rofile. Please note, that the Seam runtime must be of the version you initi= ally specified in the project settings (See the Creating Seam Web Project figure). - When creating a Seam project with BIRT capabilities you can use= the BIRT Classic Models Sample Database connection pr= ofile to work with the BIRT sample database. - - For more details on how to configure database connection for a S= eam project please read the = - Configure Seam Facet Settings = chapter of Seam Dev Tools Reference Guide. + + On the Seam Facet page you should specify the Se= am runtime and Connection profile. Please note that the Seam runtime must b= e the same version you initially specified in the project settings (See ). + + = + When creating a Seam project with BIRT capabilities you can use the <= guilabel>BIRT Classic Models Sample Database connection profile = to work with the BIRT sample database. + + = + + For more details on how to configure database connection for a Seam p= roject please read the Configure Seam Facet Settings chapter of Seam Dev Tools Reference Guide. +
Configuring the Seam Facet settings @@ -126,27 +135,24 @@ -
- + = - = = + = - Hit - Finish - to create the project with BIRT functionality enabled. + Click the Finish button to create the pro= ject with BIRT functionality enabled.
- + =
Integration with Seam In the previous section you have created a Seam project with BIRT capa= bilities. = Now you can create a simple kick start project to see that everything = is configured correctly. = - = = + = Now create a BIRT report file and insert test data into the fil= e. @@ -161,51 +167,51 @@ You can download the file helloBirt.rptdesign here and copy it to = the WebContent folder of your Seam project. - + = - + = When you are done with the helloBirt.rptdesign file, you should create a .xhtml file that will = contain the BIRT report you have just created. - = = + = = The JBoss BIRT Integration framework provides 2 components repre= sented as <b:birt> and <b:param> tags. The jboss-seam-birt.jar library implements the func= tionality of the components. To find more information about the framework p= leas read the JBoss BIRT Integraion Framework = API Reference chapter. To use that tags on the page you need to declare the tag lib= rary and define the name space like this: = - = = + = - + = The <b:birt> is a container for a BIRT report, that helps you integrat= e the report into Seam environment. = You can manage the properties of the report using the attributes= of the <b:birt> tag. - + = = The <b:param> 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 wi= th back-end logic. - + = - = = = = + = - = = + = Create the helloBirt.xhtml file in the Web= Content with the following content: - + = @@ -225,20 +231,20 @@ = ...]]> - + = From this listing above you see that the title of the report is = set via <b:param> by setting the parameter name and defining the = "value" attribute with the "Customers Contacts" value.<= /para> - + = - = = = = + = We have created a Seam project and inserted the hello= Birt report into the helloBirt.xhtml view f= ile. - = = + = To see that the application works correctly and as you expect, y= ou need to launch it on the server. @@ -246,8 +252,8 @@ When the server is started, open your favourite browser and poin= t it to http://localhost:8080/HelloBirt/helloBirt.seam . - = = + =
Integrating BIRT into Seam Project @@ -258,6 +264,6 @@
- + =
\ No newline at end of file --===============1839267554724498140==--