From jbosstools-commits at lists.jboss.org Mon Mar 7 17:06:55 2011 Content-Type: multipart/mixed; boundary="===============1004031957422212941==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r29584 - trunk/birt/docs/en-US. Date: Mon, 07 Mar 2011 17:06:55 -0500 Message-ID: <201103072206.p27M6tEp006627@svn01.web.mwc.hst.phx2.redhat.com> --===============1004031957422212941== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: mcaspers Date: 2011-03-07 17:06:55 -0500 (Mon, 07 Mar 2011) New Revision: 29584 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 22:06:0= 6 UTC (rev 29583) +++ trunk/birt/docs/en-US/birt_integration_with_seam.xml 2011-03-07 22:06:5= 5 UTC (rev 29584) @@ -1,208 +1,212 @@
- Adding BIRT Functionality to Standard Seam Web Project + Adding BIRT Functionality to Standard Seam Web Project = - In this section you'll know how to integrate BIRT into a Se= am web project. + This section discusses the process of integrating BIRT into a Seam = web project. = - You are supposed to have Seam runtime and JBoss Application Serv= er downloaded and - extracted on your hard drive. = - You can download Seam from the - Seam Framework web page and = - JBoss Application Server from JBoss Application Server official site. - = + + 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: - We used JBoss Seam 2.0.1 GA and JBoss Application Server 4.2.2 GA in examples= of this guide. - + + Tip: + + JBoss Seam 2.0.1 GA and JBoss Application Server 4.2.2 GA were used in the exa= mples presented in this guide. + + = -
- Creating Seam Web Project with Birt Facet +
+ Creating Seam Web Project with Birt Facet = - We recommend to open Seam perspective b= y going to - Window > Open Perspective > Other > Seam , this way you will have all the tools to work with Sea= m at hand. - To create a new Seam Web project navigate to - File > New > Seam Web Project - . Otherwise you should go to = - = - File > New > Other > Seam > Seam Web - Project - if Seam perspective is not a= ctive. + + It is recommended that you open the Seam Perspective by selecting WindowOpen PerspectiveOtherSeam. This perspective provides conventient access to all the Seam too= ls. = + + + To create a new Seam Web project select FileNewSeam Web Project. If the Seam Perspective is not active, select = + FileNewOtherSeamSeam Web Project. + = - = - = - - On the first wizard page enter the project name, then sp= ecify the target runtime and + + + + 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. - = = -
- Creating Seam Web Project - - - - - -
- - - In the Configuration group choose the version of + +
+ Creating Seam Web Project + + + + + +
+ + + 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. - - - Click the Modify button + framework you are planning to use in your application. 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. + facet by checking the appropriate option. = -
- Adding the Birt Reporting Runtime Component Facet </tit= le> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/birt_integration_with_sea= m/addingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Alternatively you can just choose the <emphasis> + <figure> + <title>Adding the Birt Reporting Runtime Component Facet + + + + + +
+ Alternatively you can just choose the JBoss BIRT Integration Web Project - configuration from the drop-down list in the <= emphasis>Configuration group - = -
- Choosing the JBoss BIRT Integration Web Project= Configuration - - - - - -
- = - - = + configuration from the drop-down list in the Configuration + group + +
+ Choosing the JBoss BIRT Integration Web Project Configuration<= /title> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/birt_integration_with_seam/projectBirt= Configuration.png"/> + </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. + + <listitem> + <para>You may leave the next two pages with default values, just press= <emphasis><property>Next</property> + </emphasis> to proceed. </para> - </listitem> = - = - <listitem> - = - <para>On the <emphasis><property>Birt Configuration</prope= rty></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 t= he default values for now. + </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> - = - <figure> - <title>Configuring BIRT Deployment Settings - - - - - -
+ +
+ Configuring BIRT Deployment Settings + + + + + +
= = - = - - = - = - You can also leave the JSF Capabilit= ies page with default values. = - - = - - On the + + + + + You can also leave the JSF Capabilities + page with default values. + + + + On the Seam Facet - page you should specify the Seam runtime and Con= nection profile. Please note, that the Seam runtime must be of the version = you initially specified in the project settings (See the Creating Seam Web Project figure). - When creating a Seam project with BIRT capabilities y= ou can use the BIRT Classic Models Sample Database con= nection profile to work with the BIRT sample database. - = - For more details on how to configure database connecti= on for a Seam project please read the = + 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. -
- Configuring the Seam Facet settings - - - - - -
- = - - = +
+ Configuring the Seam Facet settings + + + + + +
+ + = - = - Hit + + + Hit Finish - to create the project with BIRT functionality enabled.= - - -
+ to create the project with BIRT functionality enabled. + + +
= -
- Integration with Seam - +
+ 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 file. + + + + Now create a BIRT report file and insert test data into the fil= e. Name the report file helloBirt.rptdesign, the report should print the data from the CLASSICMODELS.CUSTOMER= S table of the BIRT Classic Models Sample Database, namely: customer number (CLASSICMODELS.CUSTOMERS.CUSTOMERNAME), = contact person first name ( CLASSICMODELS.CUSTOMERS= .CONTACTFIRSTNAME) , contact person last name (CLASSICMODELS.CUSTOMERS.CO= NTACTLASTNAME) and = contact person phone number(CLASSICMODELS.CUSTOMERS.= PHONE). = - The title of the report should be set via reportT= itle parameter = - + The title of the report should be set via reportTitle parameter + As this guide is primarily focused on the BIRT integra= tion and not the BIRT technology itself we will not show the steps required= to make the report. If you do not feel strong about creating a BIRT report= file please read = BIRT documentation. - = - You can download the file helloBirt.rptde= sign here and c= opy it to the WebContent folder of your Seam project. = - = - - = - - + + 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 functionality= of the components. To find more information about the framework pleas read= the JBoss BIRT Integraion Framework API Refer= ence chapter. + + = + 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 integrate the = report into Seam environment. = - You can manage the properties of the report using the attributes= of the <b:birt> tag. + + 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 nee= d to specify it's name the value you want to pass. = + 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 fil= e in the WebContent with the following content: - = - Create the helloBirt.xhtml file in the Web= Content with the following content: + + = -...]]> = - = - From this listing above you see that the title of t= he report is set via <b:param> by setting the parameter name and defining the "value" attribute with the "= ;Customers Contacts" value. - = - - = +...]]> + + 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 h= elloBirt report into the helloBirt.xhtml vi= ew file. = + + + 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, you n= eed to launch it on the server. - - In the Servers view (If it is not= open navigate to Windows > Show View > Other > Server > Servers<= /property>), select the server the application is deployed to and hit the <= property>Start button. - - When the server is started, open your favourite browser and = point it to http://localhost:8080/HelloBirt/helloBirt.seam . + + To see that the application works correctly and as you expect, y= ou need to launch it on the server. + + + In the Servers view (If it is not open navi= gate to Windows > Show View > Other > Server > Servers= ), select the server the application is deployed to and hit the S= tart button. + + + 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 - - - - - -
= - - - = -
+ +
+ Integrating BIRT into Seam Project + + + + + +
+ + + +
\ No newline at end of file --===============1004031957422212941==--