[jbosstools-commits] JBoss Tools SVN: r29594 - trunk/birt/docs/en-US.

Author: mcaspers Date: 2011-03-07 21:24:01 -0500 (Mon, 07 Mar 2011) New Revision: 29594 Modified: trunk/birt/docs/en-US/birt_integration_with_seam.xml trunk/birt/docs/en-US/hibernate_datasource.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-08 00:32:43 UTC (rev 29593) +++ trunk/birt/docs/en-US/birt_integration_with_seam.xml 2011-03-08 02:24:01 UTC (rev 29594) @@ -154,7 +154,7 @@ <orderedlist> <listitem> <para> - Now create a BIRT report file and insert test data into the file. Name the report file <filename>helloBirt.rptdesign</filename>. + Now create a BIRT report file and insert test data into the file. Name the report file <filename>helloBirt.rptdesign</filename> in the <filename>WebContent</filename> folder. </para> <para> The report should print the data from the <code>CLASSICMODELS.CUSTOMERS</code> table of the <guilabel>BIRT Classic Models Sample Database</guilabel>, namely: @@ -217,7 +217,7 @@ <listitem> - <para>Create the <property>helloBirt.xhtml</property> file in the WebContent with the following content: </para> + <para>Create the <filename>helloBirt.xhtml</filename> file in the <filename>WebContent</filename> folder with the following content: </para> <programlisting role="XML"><![CDATA[... <!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" @@ -239,9 +239,9 @@ </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> + <para> + From this listing above you see that the title of the report is set via <code>&lt;b:param&gt;</code> by setting the parameter name and defining the <code>value</code> attribute with the <code>Customers Contacts</code> value. + </para> </listitem> @@ -249,13 +249,15 @@ <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> + We have created a Seam project and inserted the <filename>helloBirt</filename> report into the <filename>helloBirt.xhtml</filename> 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> - <para>In the <property>Servers</property> view (If it is not open navigate to <property>Windows > Show View > Other > Server > Servers</property>), select the server the application is deployed to and hit the <property>Start</property> button. </para> + <para>In the <guilabel>Servers</guilabel> view (if it is not open select <menuchoice><guimenuitem>Windows</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Server</guimenuitem><guimenuitem>Servers</guimenuitem></menuchoice>), select the server the application is deployed to and hit the <guibutton>Start</guibutton> button. </para> </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> Modified: trunk/birt/docs/en-US/hibernate_datasource.xml =================================================================== --- trunk/birt/docs/en-US/hibernate_datasource.xml 2011-03-08 00:32:43 UTC (rev 29593) +++ trunk/birt/docs/en-US/hibernate_datasource.xml 2011-03-08 02:24:01 UTC (rev 29594) @@ -2,212 +2,191 @@ <section id="hibernate_datasource"> - <title>Using Hibernate ODA Data Source</title> + <title>Using Hibernate ODA Data Source</title> - <para>The JBoss BIRT Integration feature includes the Hibernate ODA Data Source which is completely + <para>The JBoss BIRT Integration feature includes the Hibernate ODA Data Source which is completely integrated with Hibernate Tools. You can use it the way as you would use any of BIRT ODA drivers. </para> -<orderedlist> - <listitem> - <para>First, you need to reverse engineer from the database to generate Seam entities. You can perform this operation going to <emphasis> - <property>File &gt; New &gt; Seam Generate Entities</property> - </emphasis> in the <property>Seam perspective</property>. More details on the Seam Generate - Entities please read <ulink - url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_... - >Seam Dev Tools Reference guide</ulink>). - In this guide we will use the <property>Employees</property> table of the <property>DATAMODELS</property> database. -</para> + <orderedlist> + <listitem> + <para> + First, you need to reverse engineer from the database to generate Seam entities. You can perform this operation going to <menuchoice><guimenuitem>File</guimenuitem> + <guimenuitem>New</guimenuitem> + <guimenuitem>Seam Generate Entities</guimenuitem> + </menuchoice> in the <property>Seam perspective</property>. More details on the Seam Generate Entities please read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_... Dev Tools Reference guide</ulink>). In this guide we will use the <property>Employees</property> table of the <property>DATAMODELS</property> database. + </para> - <note> - <title>Tip:</title> - <para>Before performing Seam Generate Entities, you should have a connection profile - adjusted and connected to a database. How to do this see in the <ulink - url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_... - >CRUD Database Application</ulink> chapter of the Seam Dev Tools Reference + <note> + <title>Tip:</title> + <para>Before performing Seam Generate Entities, you should have a connection profile + adjusted and connected to a database. How to do this see in the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_... Database Application</ulink> chapter of the Seam Dev Tools Reference guide.</para> - <para> + <para> If you followed the steps described in the <link linkend="birt_integration_with_seam">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, you would have a connection profile already configured. </para> - </note> - </listitem> - <listitem> -<para> - Next you should create a new BIRT report file ( <emphasis>><property>File &gt; New &gt; Other &gt; Business Intelligence and Reporting - Tools &gt; Report</property></emphasis>) to represent the data from the <property>Employees</property> table. Call the file <property>employees.rptdesign</property>. -</para> - </listitem> + </note> + </listitem> + <listitem> + <para> + Next you should create a new BIRT report file (<menuchoice><guimenuitem>File</guimenuitem> + <guimenuitem>New</guimenuitem> + <guimenuitem>Other</guimenuitem> + <guimenuitem>Business Intelligence and Reporting Tools</guimenuitem> + <guimenuitem>Report</guimenuitem> + </menuchoice>) to represent the data from the <property>Employees</property> table. Call the file <filename>employees.rptdesign</filename>. + </para> + </listitem> -<listitem> - + <listitem> - <para>Now switch to the <property>BIRT Report Design</property> perspective.</para> -</listitem> - <listitem> - <para>In the <property>Data Explorer</property> view right-click the <emphasis> - <property>Data Source</property> - </emphasis> node and choose <emphasis> - <property>New Data Source</property>.</emphasis></para> - <figure> - <title>Creating a New Data Source</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/creatingDataSource.png"/> - </imageobject> - </mediaobject> - </figure> -</listitem> - <listitem> - <para>The wizard will prompt you to select data source type. Choose <emphasis> - <property>Hibernate Data Source</property> - </emphasis> and give it a meaningful name, for instance <emphasis> - <property>HibernateDataSource</property> - </emphasis>. Hit <emphasis> - <property>Next</property> to proceed.</emphasis></para> + <para>Now switch to the <property>BIRT Report Design</property> perspective.</para> + </listitem> + <listitem> + <para> + In the <guilabel>Data Explorer</guilabel> view right-click the <guilabel>Data Source</guilabel> node and choose <guimenuitem>New Data Source</guimenuitem>. + </para> - <figure> - <title>Creating Hibernate Data Source</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the next wizard's dialog you can leave the everything with default values, press the <emphasis> - <property>Test Connection</property> - </emphasis> button to verify that the connection is established successfully.</para> - - <para> - The <property>Hibernate Data Source</property> enables you to specify a Hibernate Configuration or JNDI URL. - - </para> + <figure> + <title>Creating a New Data Source</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_datasource/creatingDataSource.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para> + The wizard will prompt you to select data source type. Choose <guilabel>Hibernate Data Source</guilabel> and give it a meaningful name, for instance <guilabel>HibernateDataSource</guilabel>. Click the <guibutton>Next</guibutton> button to proceed. + </para> - <figure> - <title>Hibernate Data Source Profile</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Press <emphasis> - <property>Finish</property> - </emphasis> to complete <property>New Data Source</property> wizard.</para> - </listitem> - - <listitem> - <para>Now you need to configure a new Hibernate ODA data set. Launch the - <property>New Data Set</property> wizard. In the <property>Data Explorer View</property> - right-click the <emphasis> - <property>Data Set</property> - </emphasis> node and select <emphasis> - <property>New Data Set</property>.</emphasis></para> + <figure> + <title>Creating Hibernate Data Source</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para> + On the next wizard's dialog you can leave the everything with default values, click the <guibutton>Test Connection</guibutton> button to verify that the connection is established successfully. + </para> - </listitem> - <listitem> - <para>Select <property>HibernateDataSource</property> as target data source and type in the new data set name. + <para> + The <guilabel>Hibernate Data Source</guilabel> enables you to specify a Hibernate Configuration or JNDI URL. + </para> + + <figure> + <title>Hibernate Data Source Profile</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Click the <guibutton>Finish</guibutton> button to complete <guilabel>New Data Source</guilabel> wizard.</para> + </listitem> + + <listitem> + <para> + Now you need to configure a new Hibernate ODA data set. Launch the <guilabel>New Data Set</guilabel> wizard. In the <guilabel>Data Explorer</guilabel> View right-click the <guilabel>Data Set</guilabel> node and select <guimenuitem>New Data Set</guimenuitem>. + </para> + + </listitem> + <listitem> + <para>Select <property>HibernateDataSource</property> as target data source and type in the new data set name. Call it <property>HibernateDataSet</property>.</para> - <figure> - <title>Creating a Hibernate ODA Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> + <figure> + <title>Creating a Hibernate ODA Data Set</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> - <para>The next dialog of the wizard will help you compose a query for the new data set.</para> - <para>We will make a report that will print all employees in the database who has Sales Rep job title.</para> + <para>The next dialog of the wizard will help you compose a query for the new data set.</para> + <para>We will make a report that will print all employees in the database who has Sales Rep job title.</para> - <programlisting role="SQL"><![CDATA[... + <programlisting role="SQL"><![CDATA[... select jobtitle, firstname, lastname, email from Employees as employees where employees.jobtitle = 'Sales Rep' -...]]></programlisting> - +...]]></programlisting> - <para> - - To validate the - entered query you can press the <emphasis> - <property>Test query</property> - </emphasis> button. All the HQL features like syntax highlighting, content assist, - formatting, drag-and-drop, etc., are available to facilitate query composing.</para> - <figure> - <title>Composing query for Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/testingQuery.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - - <para>Pressing <property>Finish</property> will call the <property>Edit Data Set</property> dialog where you can adjust the parameters of the data set and preview the resulted set. - If everything looks good, hit <property>Ok</property> to generate a new data set. + <para> + To validate the entered query you can press the <guibutton>Test query</guibutton> button. All the HQL features like syntax highlighting, content assist, formatting, drag-and-drop, etc., are available to facilitate query composing. + </para> + + <figure> + <title>Composing query for Data Set</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_datasource/testingQuery.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + + <para> + Clicking the <guibutton>Finish</guibutton> button will call the <guilabel>Edit Data Set</guilabel> dialog where you can adjust the parameters of the data set and preview the resulted set. If everything looks good, click the <guibutton>OK</guibutton> button to generate a new data set. </para> - </listitem> - <listitem> - - <para>Now you can insert the data set items of <property>HibernateDataSet</property> into the <property>employees.rptdesign</property>.</para> - + </listitem> + <listitem> - <note> - <title>Tip:</title> - <para>If you don&apos;t know how to do this we suggest that you refer to the <ulink - url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para> - </note> - + <para>Now you can insert the data set items of <guilabel>HibernateDataSet</guilabel> into the <filename>employees.rptdesign</filename> file.</para> -<para>You can also use parameters in the query to add dynamics to your report. In the previous example we hardcoded the selection criterion in the <code>where</code> clause. </para> - <para>To specify the job title on-the-fly your query should look like this:</para> - <programlisting role="XML"><![CDATA[ + + <note> + <title>Tip:</title> + <para>If you don&apos;t know how to do this we suggest that you refer to the <ulink url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para> + </note> + + + <para>You can also use parameters in the query to add dynamics to your report. In the previous example we hardcoded the selection criterion in the <code>where</code> clause. </para> + <para>To specify the job title on-the-fly your query should look like this:</para> + <programlisting role="XML"><![CDATA[ select jobtitle,firstname, lastname,email from Employees as employees where employees.jobtitle = ? -]]></programlisting> - - <para>The question mark represents a data set input parameter, which is not the same as a report parameter. - Now you need to define an new report parameter to pass the data to the report, call it <code>JobTitle</code>. - - - - The dataset parameter can be linked to a report parameter. - In the <property>Data Explorer</property> view click the Data Set node to open it and right-click - on the data set you created previously( in our case it is <property>HibernateDataSet</property>), - choose <property>Edit</property> and navigate to the <property>Parameters</property> section. - Declare a new data set parameter, name it <code>jobtitle</code> and map it to the already existing <code>JobTitle</code> report parameter. - </para> - </listitem> - <listitem> - <para>You report is ready, you can view it by clicking on the <property>Preview</property> tab of the <property>BIRT Report Designer</property> editor. </para> +]]></programlisting> + <para> + The question mark represents a data set input parameter, which is not the same as a report parameter. Now you need to define an new report parameter to pass the data to the report, call it <code>JobTitle</code>. The dataset parameter can be linked to a report parameter. In the <guilabel>Data Explorer</guilabel> view click the Data Set node to open it and right-click on the data set you created previously (in our case it is <guilabel>HibernateDataSet</guilabel>), choose <guilabel>Edit</guilabel> and navigate to the <guilabel>Parameters</guilabel> section. Declare a new data set parameter, name it <code>jobtitle</code> and map it to the already existing <code>JobTitle</code> report parameter. + </para> + </listitem> + <listitem> + <para> + You report is ready, you can view it by clicking on the <guilabel>Preview</guilabel> tab of the <guilabel>BIRT Report Designer</guilabel> editor. + </para> - <para>You will be prompted to assign a value to the report parameter. For instance you can enter &quot;Sales Rep&quot;. </para> - <figure> - <title>Resulted Dynamic Report</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/finalReport.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> -</orderedlist> + <para>You will be prompted to assign a value to the report parameter. For instance you can enter &quot;Sales Rep&quot;. </para> + + <figure> + <title>Resulted Dynamic Report</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_datasource/finalReport.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> </section>