[jbosstools-commits] JBoss Tools SVN: r14272 - trunk/birt/docs/en/modules.

Author: smukhina Date: 2009-03-19 19:03:47 -0400 (Thu, 19 Mar 2009) New Revision: 14272 Modified: trunk/birt/docs/en/modules/birt_designer.xml trunk/birt/docs/en/modules/birt_integration.xml trunk/birt/docs/en/modules/birt_support.xml Log: https://jira.jboss.org/jira/browse/JBDS-359 - spelling and validation is checked Modified: trunk/birt/docs/en/modules/birt_designer.xml =================================================================== --- trunk/birt/docs/en/modules/birt_designer.xml 2009-03-19 19:05:23 UTC (rev 14271) +++ trunk/birt/docs/en/modules/birt_designer.xml 2009-03-19 23:03:47 UTC (rev 14272) @@ -142,7 +142,7 @@ etc.</para> </listitem> <listitem> - <para><emphasis role="bold">Cheat Sheets</emphasis> - Cheat sheets are small pices + <para><emphasis role="bold">Cheat Sheets</emphasis> - Cheat sheets are small peaces of useful documentation that lead you through a report creation process. Just select what you need and then follow the instructions.</para> </listitem> Modified: trunk/birt/docs/en/modules/birt_integration.xml =================================================================== --- trunk/birt/docs/en/modules/birt_integration.xml 2009-03-19 19:05:23 UTC (rev 14271) +++ trunk/birt/docs/en/modules/birt_integration.xml 2009-03-19 23:03:47 UTC (rev 14272) @@ -288,7 +288,7 @@ ]]></programlisting> <figure> - <title>Embeding BIRT Report in Seam xhtml Page. First Page</title> + <title>Embedding BIRT Report in Seam xhtml Page. First Page</title> <mediaobject> <imageobject> <imagedata fileref="images/BirtIntegration/BirtReportInSeamPage1.png"/> @@ -297,7 +297,7 @@ </figure> <figure> - <title>Embeding BIRT Report in Seam xhtml Page. Second Page</title> + <title>Embedding BIRT Report in Seam xhtml Page. Second Page</title> <mediaobject> <imageobject> <imagedata fileref="images/BirtIntegration/BirtReportInSeamPage2.png"/> @@ -306,7 +306,7 @@ </figure> <figure> - <title>Embeding BIRT Report in Seam xhtml Page. Third Page</title> + <title>Embedding BIRT Report in Seam xhtml Page. Third Page</title> <mediaobject> <imageobject> <imagedata fileref="images/BirtIntegration/BirtReportInSeamPage3.png"/> Modified: trunk/birt/docs/en/modules/birt_support.xml =================================================================== --- trunk/birt/docs/en/modules/birt_support.xml 2009-03-19 19:05:23 UTC (rev 14271) +++ trunk/birt/docs/en/modules/birt_support.xml 2009-03-19 23:03:47 UTC (rev 14272) @@ -1,64 +1,64 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="esb_support"> - <?dbhtml filename="esb_support.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>BIRT</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> +<?dbhtml filename="esb_support.html"?> +<chapterinfo> +<keywordset> +<keyword>JBoss Developer Studio</keyword> +<keyword>Eclipse</keyword> +<keyword>BIRT</keyword> +<keyword>Java</keyword> +<keyword>JBoss</keyword> +</keywordset> +</chapterinfo> <title>BIRT Support</title> - + <para>In this section we will focus more on all concepts that JBoss Tools integrates for - working with BIRT.</para> - - <section> - <title>BIRT Plugin Installation</title> + working with BIRT.</para> + + <section> + <title>BIRT Plugin Installation</title> + + <para>This chapter will provide you with detailed information on how to install BIRT plugin into JBoss Developer Studio.</para> + + <para>Since BIRT plugin is one of the modules of JBoss Tools project it has a dependence on other modules and will require their pre-installation. </para> + + <para>These are the prerequisites to create a web project including Seam and BIRT capabilities:</para> + <itemizedlist> + <listitem><para>Eclipse Version 3.4 SDK</para></listitem> + <listitem><para>DTP Version 1.6 Release</para></listitem> + <listitem><para>EMF Version 2.4 Release EMF+XSD</para></listitem> + <listitem><para>GEF Version 3.4 Release runtime</para></listitem> + <listitem><para>WTP Version 3.0 Release</para></listitem> + <listitem><para><ulink url="http://repository.jboss.org/eclipse/birt/2.3.0/birt-report-fram... Report Designer SDK 2.3.0 Release</ulink> or BIRT Report Designer 2.3.0 Release</para></listitem> + <listitem><para>JBoss Application Server 4.2.2 GA</para></listitem> + <listitem><para>JBoss Seam 2.0.1 GA</para></listitem> + <listitem><para><ulink url="http://repository.jboss.org/eclipse/birt/2.3.0/birt-wtp-integra... Web Tools Integration</ulink></para></listitem> + <listitem><para>JBoss Tools nightly build</para></listitem> - <para>This chapter will provide you with detailed information on how to install BIRT plugin into JBoss Developer Studio.</para> - - <para>Since BIRT plugin is one of the modules of JBoss Tools project it has a dependence on other modules and will require their pre-installation. </para> - - <para>These are the prerequisites to create a web project including Seam and BIRT capabilities:</para> - <itemizedlist> - <listitem><para>Eclipse Version 3.4 SDK</para></listitem> - <listitem><para>DTP Version 1.6 Release</para></listitem> - <listitem><para>EMF Version 2.4 Release EMF+XSD</para></listitem> - <listitem><para>GEF Version 3.4 Release runtime</para></listitem> - <listitem><para>WTP Version 3.0 Release</para></listitem> - <listitem><para><ulink url="http://repository.jboss.org/eclipse/birt/2.3.0/birt-report-fram... Report Designer SDK 2.3.0 Release</ulink> or BIRT Report Designer 2.3.0 Release</para></listitem> - <listitem><para>JBoss Application Server 4.2.2 GA</para></listitem> - <listitem><para>JBoss Seam 2.0.1 GA</para></listitem> - <listitem><para><ulink url="http://repository.jboss.org/eclipse/birt/2.3.0/birt-wtp-integra... Web Tools Integration</ulink></para></listitem> - <listitem><para>JBoss Tools nightly build</para></listitem> - - </itemizedlist> - - - - </section> - -<section> + </itemizedlist> + + + + </section> - <title>JBoss BIRT Integration</title> - <para>To understand Hibernate configuration, integration with Seam, and deployment see <ulink url="http://docs.jboss.org/tools/whatsnew/birt/birt-news-1.0.0.Alpha... BIRT Integration 1.0.0.alpha1 - New and Noteworthy</ulink>.</para> + <section> + + <title>JBoss BIRT Integration</title> + <para>To understand Hibernate configuration, integration with Seam, and deployment see <ulink url="http://docs.jboss.org/tools/whatsnew/birt/birt-news-1.0.0.Alpha... BIRT Integration 1.0.0.alpha1 - New and Noteworthy</ulink>.</para> + + </section> -</section> - - <section> - <title>Creating a BIRT Report</title> - <para>In this chapter we suggest a step-by-step walk-through of creating your own BIRT report.</para> + <section> + <title>Creating a BIRT Report</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own BIRT report.</para> + + <section><title>Create a Report Project</title> + + <para>First create a Report project. Select <emphasis><property>File &gt; New &gt; Project...</property> + </emphasis> in the main menu bar or context menu. The new project dialog appears. Choose <emphasis><property>Business Intelligence and Reporting Tools &gt; Report Project</property></emphasis>: - <section><title>Create a Report Project</title> - - <para>First create a Report project. Select <emphasis><property>File &gt; New &gt; Project...</property> - </emphasis> in the main menu bar or context menu. The new project dialog appears. Choose <emphasis><property>Business Intelligence and Reporting Tools &gt; Report Project</property></emphasis>: - - <figure> + <figure> <title>New Report Project Creation</title> <mediaobject> <imageobject> @@ -66,9 +66,9 @@ </imageobject> </mediaobject> </figure> - - Click on the <emphasis><property>Next</property></emphasis> button. Specify a name for the project and change location if necessary:</para> + Click on the <emphasis><property>Next</property></emphasis> button. Specify a name for the project and change location if necessary:</para> + <figure> <title>Specify a Name for the Report Project</title> <mediaobject> @@ -77,10 +77,10 @@ </imageobject> </mediaobject> </figure> - + <para>Click on the <emphasis><property>Finish</property></emphasis> button. Click <emphasis><property>Ok</property></emphasis> to switch to the Report Design perspective. Your Report Project is now created:</para> - - + + <figure> <title>New Report Project Created</title> <mediaobject> @@ -89,11 +89,11 @@ </imageobject> </mediaobject> </figure> - </section> - - <section> <title>Create a Report</title> + </section> + + <section> <title>Create a Report</title> <para>Now you can create a Report. Go to <emphasis><property>File &gt; New &gt; Report...</property></emphasis>:</para> - + <figure> <title>Create a New Report</title> <mediaobject> @@ -102,7 +102,7 @@ </imageobject> </mediaobject> </figure> - + <para>The new report dialog appears. Select the created project as a parent folder in the tree view:</para> <figure> @@ -113,153 +113,153 @@ </imageobject> </mediaobject> </figure> - - <para>Click on the <emphasis><property>Next</property></emphasis> button. Then select the type of the template to use for your report. Each template is shown in the Preview window and is described below. Tick off the "Show Report Creation Cheat Sheet" checkbox if you don't need the Cheat Sheets view to be displayed. The Cheat Sheets view can walk you though the process of creating a report based on the template you selected. - - <figure> - <title>Choose a Report Template</title> + + <para>Click on the <emphasis><property>Next</property></emphasis> button. Then select the type of the template to use for your report. Each template is shown in the Preview window and is described below. Tick off the "Show Report Creation Cheat Sheet" checkbox if you don't need the Cheat Sheets view to be displayed. The Cheat Sheets view can walk you though the process of creating a report based on the template you selected. + + <figure> + <title>Choose a Report Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/06ReportTemplate.png"/> + </imageobject> + </mediaobject> + </figure> + + + Click on the <emphasis><property>Finish</property></emphasis> button to open the newly created report in the workspace:</para> + + <figure> + <title>Report Opened in the Workspace</title> <mediaobject> <imageobject> - <imagedata fileref="images/BirtSupport/06ReportTemplate.png"/> + <imagedata fileref="images/BirtSupport/07SimpleListingReport.png"/> </imageobject> </mediaobject> </figure> - - - Click on the <emphasis><property>Finish</property></emphasis> button to open the newly created report in the workspace:</para> - - <figure> - <title>Report Opened in the Workspace</title> + + </section> + + <section> + <title>Build a Data Source</title> + + <para>Data source is used to connect to the database. In order to create a data source for your report follow these steps:</para> + <para>Open the Data Explorer View. Select Data Sources, right-click on it and choose New Data Source:</para> + + + <figure> + <title>Create a Data Source</title> <mediaobject> <imageobject> - <imagedata fileref="images/BirtSupport/07SimpleListingReport.png"/> + <imagedata fileref="images/BirtSupport/08DataSource.png"/> </imageobject> </mediaobject> </figure> - - </section> - <section> - <title>Build a Data Source</title> - - <para>Data source is used to connect to the database. In order to create a data source for your report follow these steps:</para> - <para>Open the Data Explorer View. Select Data Sources, right-click on it and choose New Data Source:</para> - - - <figure> - <title>Create a Data Source</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/08DataSource.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The New Data Source dialog appears. Choose the "Create from a data source type in the following list" radio button and then "Classic Models Inc. Sample Database". Click on the <emphasis><property>Next</property></emphasis> button:</para> - - - <figure> - <title>New Data Source</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/09NewDataSource.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The newly created data source details wll be displayed: Driver Class, Database URL and Database User:</para> - - <figure> - <title>New Data Source Details</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/10NewSampleDateSource.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click on the <emphasis><property>Finish</property></emphasis> button to add the data source to the data source for your report.</para> - + <para>The New Data Source dialog appears. Choose the "Create from a data source type in the following list" radio button and then "Classic Models Inc. Sample Database". Click on the <emphasis><property>Next</property></emphasis> button:</para> + + + <figure> + <title>New Data Source</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/09NewDataSource.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The newly created data source details will be displayed: Driver Class, Database URL and Database User:</para> + + <figure> + <title>New Data Source Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/10NewSampleDateSource.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <emphasis><property>Finish</property></emphasis> button to add the data source to the data source for your report.</para> + <para>If you need to edit the data source, right-click on it and select the corresponding option.</para> - </section> + </section> + + + <section><title>Build a Data Set</title> + <para>Data Set is a query to get and represent necessary column data from the data source specified. Select Data Sets in the tree view, right-click on it and select New Data Set:</para> - <section><title>Build a Data Set</title> + <figure> + <title>Create a Data Set</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/11DataSet.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Data Set is a query to get and represent necessary column data from the data source specified. Select Data Sets in the tree view, right-click on it and select New Data Set:</para> - - <figure> - <title>Create a Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/11DataSet.png"/> - </imageobject> - </mediaobject> - </figure> - - - <para>The New Data Set dialog will appear. Enter a name for the Data Set Name field and ensure that the Data Source field shows the data source already created and that the Data Set Type field is set to "SQL Select Query". - Then click on the <emphasis><property>Next</property></emphasis> button:</para> + <para>The New Data Set dialog will appear. Enter a name for the Data Set Name field and ensure that the Data Source field shows the data source already created and that the Data Set Type field is set to "SQL Select Query". + Then click on the <emphasis><property>Next</property></emphasis> button:</para> - <figure> - <title>New Data Set Details</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/12NewDataSet.png"/> - </imageobject> - </mediaobject> - </figure> - + + <figure> + <title>New Data Set Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/12NewDataSet.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Enter the following details into the query:</para> - <programlisting><![CDATA[ + <programlisting><![CDATA[ SELECT * FROM CUSTOMERS WHERE COUNTRY = 'USA']]></programlisting> - <figure> - <title>Query Details</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/13SQLQuery.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Query Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/13SQLQuery.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Click on the <emphasis><property>Finish</property></emphasis> button. The Edit Data Set window opens where you can change Data Source, Settings, Parameters and other details for the Data Set created. If switched to the Query page you can check the schemas within this database, you can expand them to see the list of tables with their columns:</para> + <para>Click on the <emphasis><property>Finish</property></emphasis> button. The Edit Data Set window opens where you can change Data Source, Settings, Parameters and other details for the Data Set created. If switched to the Query page you can check the schemes within this database, you can expand them to see the list of tables with their columns:</para> - <figure> - <title>Edit the Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/14EditDataSet.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Edit the Data Set</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/14EditDataSet.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Switch to the Preview page to test your query and verify whether the list of customers appears:</para> + <para>Switch to the Preview page to test your query and verify whether the list of customers appears:</para> - <figure> - <title>Test the Query</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/15TestQuery.png"/> - </imageobject> - </mediaobject> - </figure> - + <figure> + <title>Test the Query</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/BirtSupport/15TestQuery.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <emphasis><property>Ok</property></emphasis> button.</para> - </section> + </section> + + <section><title>Create Report Layout</title> - <section><title>Create Report Layout</title> - - <para>After the Data source and Data set are specified you can continue with the report layout. Please see the <xref linkend="Birt_Designer"/> chapter to learn more about BIRT Report Designer.</para> - - </section> + <para>After the Data source and Data set are specified you can continue with the report layout. Please see the <xref linkend="Birt_Designer"/> chapter to learn more about BIRT Report Designer.</para> - </section> - + + + </section> + </chapter>