[jbosstools-commits] JBoss Tools SVN: r15155 - in branches/jbosstools-3.0.x/birt/docs: en and 2 other directories.

Author: smukhina Date: 2009-05-11 11:18:11 -0400 (Mon, 11 May 2009) New Revision: 15155 Removed: branches/jbosstools-3.0.x/birt/docs/en/images/BirtIntegration/ branches/jbosstools-3.0.x/birt/docs/en/images/BirtSupport/ branches/jbosstools-3.0.x/birt/docs/en/modules/birt_designer.xml branches/jbosstools-3.0.x/birt/docs/en/modules/birt_integration.xml branches/jbosstools-3.0.x/birt/docs/en/modules/birt_support.xml Modified: branches/jbosstools-3.0.x/birt/docs/en/master.xml branches/jbosstools-3.0.x/birt/docs/en/modules/introduction.xml branches/jbosstools-3.0.x/birt/docs/pom.xml Log: https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the corresponding branch Modified: branches/jbosstools-3.0.x/birt/docs/en/master.xml =================================================================== --- branches/jbosstools-3.0.x/birt/docs/en/master.xml 2009-05-11 14:40:45 UTC (rev 15154) +++ branches/jbosstools-3.0.x/birt/docs/en/master.xml 2009-05-11 15:18:11 UTC (rev 15155) @@ -4,18 +4,17 @@ [ <!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY birt_support SYSTEM "modules/birt_support.xml"> -<!ENTITY birt_designer SYSTEM "modules/birt_designer.xml"> - - - +<!ENTITY birt_integration_with_seam SYSTEM "modules/birt_integration_with_seam.xml"> +<!ENTITY hibernate_datasource SYSTEM "modules/hibernate_datasource.xml"> +<!ENTITY birt_reports_deployment SYSTEM "modules/birt_reports_deployment.xml"> ]> + <book> <bookinfo> - <title>Birt Plugin Reference Guide</title> + <title>Birt Plugin Integration Reference Guide</title> <author&gt;&lt;firstname&gt;Anastasiya&lt;/firstname&gt;&lt;surname&gt;Bogachuk&lt;/surname&gt;&lt;email&gt;abogachuk(a)exadel.com&lt;/email&gt;&lt;/author&gt; - + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> <pubdate>August 2008</pubdate> <copyright> @@ -38,11 +37,10 @@ </bookinfo> <toc/> - - - &introduction; - &birt_support; - &birt_designer; + &introduction; + &birt_integration_with_seam; + &hibernate_datasource; + &birt_reports_deployment; </book> \ No newline at end of file Deleted: branches/jbosstools-3.0.x/birt/docs/en/modules/birt_designer.xml =================================================================== --- branches/jbosstools-3.0.x/birt/docs/en/modules/birt_designer.xml 2009-05-11 14:40:45 UTC (rev 15154) +++ branches/jbosstools-3.0.x/birt/docs/en/modules/birt_designer.xml 2009-05-11 15:18:11 UTC (rev 15155) @@ -1,160 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="Birt_Designer" xreflabel="Birt_Designer"> - <?dbhtml filename="birtDesigner.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss</keyword> - <keyword>BIRT</keyword> - <keyword>BIRT Designer</keyword> - <keyword>BIRT Report Designer</keyword> - </keywordset> - </chapterinfo> - - <title>BIRT Report Designer</title> - - <para>BIRT Designer is an intuitive and quite easy Eclipse-based set of plugins to make reports. - In this chapter we will describe its interface and its features to you.</para> - - <section id="birt_designer_UI" xreflabel="birt_designer_UI"> - <title>BIRT User Interface</title> - - <para>The central part of the user interface is the <property>Layout Editor</property>. It - displays the whole process of building a report and contains the following tabs:</para> - - <itemizedlist> - <listitem> - <para><emphasis role="bold">Layout</emphasis> - this is an area where you can edit - your report design;</para> - </listitem> - <listitem> - <para><emphasis role="bold">Preview</emphasis> - runs your report created and shows - the output;</para> - </listitem> - <listitem> - <para><emphasis role="bold">Script</emphasis> - on this page you can add JavaScript - to your report to customize its behavior;</para> - </listitem> - <listitem> - <para><emphasis role="bold">XML Source</emphasis> - this is an area where you can - view and modify the XML source of your report;</para> - </listitem> - <listitem> - <para><emphasis role="bold">Master Page</emphasis> - use it to format page - data.</para> - </listitem> - </itemizedlist> - - <para>The next part of user interface is different <property>Views</property> that can be - arranged around the Layout Editor area the way you like:</para> - - <itemizedlist> - <listitem> - <para><emphasis role="bold">Palette</emphasis> - shows the standard report items you - can add to your report using drag and drop.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Outline</emphasis> - shows the structure of your report - as a tree view.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Navigator</emphasis> - shows your projects and reports - within the projects.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Data Explorer</emphasis> - shows your data sources, data - sets and report parameters. You also can use this view to add data set columns - to your report layout.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Property Editor</emphasis> - displays properties for - many report items.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Properties View</emphasis> - shows all properties for a - report item as a simple list.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Library Explorer View</emphasis> - allows the reuse of - report objects, such as tables, data sources and styles. Objects created for - reuse are stored in a library file. The Library Explorer will display Libraries - that exist in the Resource folder. Developed libraries can be added to the - resource folder by selecting <emphasis>File→Publish Library in Resource - Folder</emphasis>. The resource folder location can be configured. </para> - </listitem> - - </itemizedlist> - - </section> - - <section id="birt_designer_features"> - - <title>BIRT Report Designer Features</title> - <para>Here are the main BIRT Report Designer features:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Palette</emphasis> - contains tables, labels, and - charts. It is used in conjunction with the Layout View to design reports.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Data Explorer</emphasis> - organizes your data sources - and data sets. The Data Sets editor enables testing your data set to check - whether the report receives the correct data. You can also create cubes using - your data sets (when building any dynamic cross tables) and design necessary - report parameters.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Resource Explorer</emphasis> - BIRT allows the reuse of - report objects, such as tables, data sources and styles. Objects created for - reuse are stored in a library file. To browse the contents of report libraries - BIRT supplies the Resource Explorer view. This view lists all libraries within - the resource folder, in addition to other shared content such as images and - JavaScript files.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Property Editor</emphasis> - shows the most commonly - used properties. BIRT also integrates with the standard Eclipse property view to - display a detailed listing of all properties for an item.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Layout View</emphasis> - WYSIWYG editor. You can select - any element from the Palette, drag and drop it to the report and then edit the - way you like.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Script Editor</emphasis> - scripting adds business logic - to reports during data access, report generation, or viewing. The code editor - provides standard features for editing scripts: syntax coloring, auto-complete - etc. You also can debug scripts when the report is running.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Report Preview</emphasis> - Report Preview is used to - test your newly created report with some real data.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Chart Builder</emphasis> - using the Chart Builder you - can add any charts to the design of your report. Just select a chart type, then - data and, finally, format the chart.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Expression Builder </emphasis> - expressions are simple - scripts that return a value. They are used to assign data values to report - elements, build image locations, hyperlinks, parameter default values - etc.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Cheat Sheets</emphasis> - Cheat sheets are small pices - of useful documentation that lead you through a report creation process. Just - select what you need and then follow the instructions.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Outline</emphasis> - this view provides a compact - overview of the entire report structure.</para> - </listitem> - </itemizedlist> - - <para>In this guide we made a short overview of the BIRT plugin: its installation, support, - features etc. that will help you to make your first steps with it.</para> - - </section> - -</chapter> Deleted: branches/jbosstools-3.0.x/birt/docs/en/modules/birt_integration.xml =================================================================== --- branches/jbosstools-3.0.x/birt/docs/en/modules/birt_integration.xml 2009-05-11 14:40:45 UTC (rev 15154) +++ branches/jbosstools-3.0.x/birt/docs/en/modules/birt_integration.xml 2009-05-11 15:18:11 UTC (rev 15155) @@ -1,548 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="Birt_Seam_Web_Project" xreflabel="Birt_Seam_Web_Project"> - - <?dbhtml filename="birtSeamWebProject.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss</keyword> - <keyword>BIRT</keyword> - <keyword>Seam</keyword> - </keywordset> - </chapterinfo> - - <title> Adding JBoss BIRT functionality to the standard Seam web project</title> - - <para>In this chapter you'll find out how to create a web project including Seam and BIRT capabilities </para> - - <section id="prerequisites" xreflabel="prerequisites"> - <title>Prerequisites</title> - - <para>These are the prerequisites required to create a Seam web project including with BIRT functionality:</para> - - <orderedlist> - <listitem> - <para> - <ulink url="http://download.eclipse.org/eclipse/downloads/drops/R-3.4-20080... Version 3.4 SDK</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://www.eclipse.org/downloads/download.php?file=/datatools/d... Version 1.6 Release</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://www.eclipse.org/modeling/emf/downloads/?project=emf"... Version 2.4 Release EMF+XSD</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://www.eclipse.org/gef/downloads/">GEF Version 3.4 Release runtime</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://download.eclipse.org/webtools/downloads/drops/R3.0/R-3.0... Version 3.0 Release</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://www.eclipse.org/downloads/download.php?file=/birt/downlo... Report Designer SDK 2.3.0 Release</ulink> or <ulink url="http://www.eclipse.org/downloads/download.php?file=/birt/downlo... Report Designer 2.3.0 Release</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&... Application Server 4.2.2 GA</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&... Seam 2.0.1 GA</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://www.eclipse.org/downloads/download.php?file=/birt/downlo... Web Tools Integration</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://download.jboss.org/jbosstools/builds/nightly/latestBuild... Tools nightly build</ulink> - </para> - </listitem> - <listitem> - <para> - <ulink url="http://jira.jboss.com/jira/secure/attachment/12320944/org.jboss... BIRT integration feature</ulink> - </para> - </listitem> - </orderedlist> - - </section> - - <section id="creating_web_project" xreflabel="creating_web_project"> - <title>Creating a web project</title> - - <para>Follow the next steps to create a web project</para> - <orderedlist> - <listitem> - <para>Create a new Seam Web Project</para> - </listitem> - <listitem> - <para>Choose the 2.0 version of the Seam facet</para> - </listitem> - <listitem> - <para>Add the &quot;Birt Reporting Runtime Component&quot; facet </para> - </listitem> - </orderedlist> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - - <orderedlist> - <listitem> - <para>Or choose the &quot;JBoss BIRT Integration Web Project&quot; - configuration</para> - </listitem> - </orderedlist> - - <figure> - <title>Choosing &quot;JBoss BIRT Integration Web Project &quot; - Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/SeamProjectConfiguration.png"/> - </imageobject> - </mediaobject> - </figure> - - <orderedlist> - <listitem> - <para>Create the birttests.xhtml, testbirt.xhtml and testbirt1.xhtml pages as - follows:</para> - </listitem> - </orderedlist> - <para> - <emphasis role="bold">birttests.xhtml:</emphasis> - </para> - - <programlisting role="XHTML"><![CDATA[ - <!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - <ui:composition xmlns="http://www.w3.org/1999/xhtml" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:ui="http://java.sun.com/jsf/facelets" xmlns:f="http://java.sun.com/jsf/core" - xmlns:h="http://java.sun.com/jsf/html" - xmlns:rich="http://richfaces.org/rich" - template="layout/template.xhtml"> - - <ui:define name="body"> - <h:messages globalOnly="true" styleClass="message"/> <rich:panel> - <f:facet name="header">Welcome to JBoss BIRT!</f:facet> - <ul> - <li><s:link view="/testbirt.xhtml" value="Test Birt" /></li> - <li><s:link view="/testbirt1.xhtml" value="Test Birt 1" /></li> - </ul> - </rich:panel> - </ui:define> - </ui:composition> - ]]></programlisting> - - - <para> - <emphasis role="bold">testbirt.xhtml:</emphasis> - </para> - - <programlisting role="XHTML"><![CDATA[ - <p:birt xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:p="http://jboss.com/products/seam/birt" - designType="run" - format="pdf" - designName="test.rptdesign" - title="JBoss Birt Test"> - - <p:param name="sample" value="sample param"/> - </p:birt> - ]]></programlisting> - - <para> - <emphasis role="bold">testbirt1.xhtml:</emphasis> - </para> - - <programlisting role="XHTML"><![CDATA[ -<p:birt xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:p="http://jboss.com/products/seam/birt" - designType="frameset" - designName="test1.rptdesign" - title="JBoss Birt Test"> - </p:birt> - ]]></programlisting> - - - <orderedlist> - <listitem> - <para>Try the tests out by accessing http://localhost:8080//birttests.seam with your web browser.</para> - </listitem> - </orderedlist> - - <figure> - <title>Trying the tests out. First Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/Tests1.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Trying the tests out. Second Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/Tests2.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Trying the tests out. Third Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/Tests3.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Trying the tests out. Forth Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/Tests4.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The birt tag recognizes most of the parameters described on <ulink url="http://www.eclipse.org/birt/phoenix/deploy/viewerUsage2.2.php#p... BIRT Report Viewer Parameters page</ulink>. The attributes of the birt tag don't contain the "__" prefix. The param tag describes report parameters. It supports the following attributes: </para> - <orderedlist> - <listitem> - <para>name - the parameter name (required)</para> - </listitem> - <listitem> - <para>value - the parameter value (required)</para> - </listitem> - <listitem> - <para>isnull - specifies that a report parameter has a null value (optional)</para> - </listitem> - <listitem> - <para>islocale - specifies whether the parameter is localized (optional)</para> - </listitem> - </orderedlist> - <para>These tags are defined in the org.jboss.birt.core/resources/jboss-seam-birt.jar library that contains source. </para> - <para>It is possible to embed a BIRT report in some Seam xhtml page. For instance: </para> - <para/> - - <para> - <emphasis role="bold">Example:</emphasis> - </para> - &lt;!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"&gt; - -&lt;ui:composition xmlns="http://www.w3.org/1999/xhtml" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:f="http://java.sun.com/jsf/core" - xmlns:h="http://java.sun.com/jsf/html" - xmlns:rich="http://richfaces.org/rich" - xmlns:b="http://jboss.com/products/seam/birt" - template="layout/template.xhtml"&gt; - -&lt;ui:define name="body"&gt; - - &lt;h:messages globalOnly="true" styleClass="message" id="globalMessages"/&gt; - - &lt;rich:panel&gt; - &lt;f:facet name="header"&gt;Products&lt;/f:facet&gt; - - &lt;b:birt designType="embed" - designName="ProductCatalog.rptdesign" - embeddable="true" - masterpage="false"&gt; - &lt;/b:birt&gt; - - - &lt;div style="clear:both"/&gt; - - &lt;/rich:panel&gt; - - &lt;div class="actionButtons"&gt; - - &lt;s:button view="/ProductsEdit.xhtml" - id="edit" - value="Edit"/&gt; - - &lt;s:button view="/BirtProductsPdf.xhtml" - id="BirtProductPdf" - value="Product Catalog - PDF"/&gt; - - &lt;s:button view="/BirtProductsFrameset.xhtml" - id="BirtProductFrameset" - value="Product Catalog - Frameset"/&gt; - - &lt;s:button view="/BirtProductsEmbedded.xhtml" - id="BirtProductEmbedded" - value="Product Catalog - Embedded"/&gt; - - &lt;s:button view="/TopSellingProducts.xhtml" - id="TopSellingProducts" - value="Top Selling Products"/&gt; - - &lt;s:button view="/#{empty productsFrom ? 'ProductsList' : productsFrom}.xhtml" - id="done" - value="Done"/&gt; - - &lt;/div&gt; - -&lt;/ui:define&gt; - -&lt;/ui:composition&gt; - - <programlisting role="XHTML"><![CDATA[ - ]]></programlisting> - -<figure> - <title>Embeding BIRT Report in Seam xhtml Page. First Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/BirtReportInSeamPage1.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Embeding BIRT Report in Seam xhtml Page. Second Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/BirtReportInSeamPage2.png"/> - </imageobject> - </mediaobject> - </figure> - - -</section> - -<section> -<title>Hibernate ODA Data Source</title> - -<para>The JBoss BIRT Integration feature includes the Hibernate ODA Data Source completely integrated with Hibernate Tools. You can use it in the way you use any of BIRT ODA drivers. For instance, </para> - <orderedlist> - <listitem> - <para>run the Seam Generate Entities action</para> - </listitem> - </orderedlist> - <para>This action will create a Hibernate Console configuration. </para> - <orderedlist> - <listitem> - <para>create a new BIRT report</para> - </listitem> - </orderedlist> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - - <orderedlist> - <listitem> - <para>add the Hibernate ODA datasource</para> - </listitem> - </orderedlist> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - - - -<orderedlist> - <listitem> - <para>add the Hibernate ODA dataset</para> - </listitem> - </orderedlist> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - -<orderedlist> - <listitem> - <para>All the HQL features like syntax highlighting, content assist, formatting, Drag and Drop, etc., are available to you here <inlinegraphic fileref="embedded:graphics15" width="8.3335inch" depth="5.2083inch"/> - </para> - </listitem> - </orderedlist> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - -<para>You can also use parameters within the Hibernate ODA driver. </para> - - -<figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - -<figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - -<figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - - -</section> - -<section> -<title>Deploying a BIRT report</title> -<para>You can deploy this report by adding an action button to the Seam&apos;s CRUD xhtml file.</para> - -<figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> -<orderedlist> - <listitem> - <para>create the testHibernateOda.xhtml file </para> - </listitem> - </orderedlist> - - <para> - <emphasis role="bold">birttests.xhtml:</emphasis> - </para> - - <programlisting role="XHTML"><![CDATA[ - -&lt;p:birt xmlns:ui="http://java.sun.com/jsf/facelets" - xmlns:s="http://jboss.com/products/seam/taglib" - xmlns:p="http://jboss.com/products/seam/birt" - designType="run" - format="pdf" - designName="testHibernateOda.rptdesign" - title="JBoss Birt Test"&gt; - -&lt;/p:birt&gt; -]]></programlisting> - -<orderedlist> - <listitem> - <para>open the Articles.xhtml page</para> - </listitem> - </orderedlist> - -<figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - -<orderedlist> - <listitem> - <para>click the Birt PDF Report button </para> - </listitem> - </orderedlist> - - <figure> - <title>Adding &quot;Birt Reporting Runtime Component&quot; Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSeamProject/AddingBirtFacet.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The JNDI URL property can be either Hibernate Session Factory or Hibernate Entity Manager Factory. If a user doesn't specify this property, our engine will try the following JNDI URLs : </para> - <orderedlist> - <listitem> - <para>java:/&lt;project_name&gt;</para> - </listitem> - <listitem> - <para>java:/&lt;project_name&gt;EntityManagerFactory</para> - </listitem> - </orderedlist></sect2><sect2><title>NOTE:</title> - <para>If you want to test this feature using PDE Runtime, you need to add osgi.dev=bin to the WebContent/WEB-INF/platform/configuration/config.ini file </para> -</section> - -</chapter> Deleted: branches/jbosstools-3.0.x/birt/docs/en/modules/birt_support.xml =================================================================== --- branches/jbosstools-3.0.x/birt/docs/en/modules/birt_support.xml 2009-05-11 14:40:45 UTC (rev 15154) +++ branches/jbosstools-3.0.x/birt/docs/en/modules/birt_support.xml 2009-05-11 15:18:11 UTC (rev 15155) @@ -1,265 +0,0 @@ -<?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> - - <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> - - <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> - - <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> - <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>: - - <figure> - <title>New Report Project Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/01ReportProjectWizard.png"/> - </imageobject> - </mediaobject> - </figure> - - 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> - <imageobject> - <imagedata fileref="images/BirtSupport/02ProjectName.png"/> - </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> - <imageobject> - <imagedata fileref="images/BirtSupport/03NewProjectCreated.png"/> - </imageobject> - </mediaobject> - </figure> - </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> - <imageobject> - <imagedata fileref="images/BirtSupport/04NewReport.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The new report dialog appears. Select the created project as a parent folder in the tree view:</para> - - <figure> - <title>Select a Parent Folder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/BirtSupport/05SelectingParentFolder.png"/> - </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> - <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/07SimpleListingReport.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>If you need to edit the data source, right-click on it and select the corresponding option.</para> - </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> - - <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> - - - <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[ -SELECT * -FROM CUSTOMERS -WHERE COUNTRY = 'USA']]></programlisting> - - - <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> - - - <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> - - <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><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> - - - </section> - -</chapter> Modified: branches/jbosstools-3.0.x/birt/docs/en/modules/introduction.xml =================================================================== --- branches/jbosstools-3.0.x/birt/docs/en/modules/introduction.xml 2009-05-11 14:40:45 UTC (rev 15154) +++ branches/jbosstools-3.0.x/birt/docs/en/modules/introduction.xml 2009-05-11 15:18:11 UTC (rev 15155) @@ -6,11 +6,9 @@ <keywordset> <keyword>JBoss Developer Studio</keyword> <keyword>Eclipse</keyword> - <keyword>Java</keyword> <keyword>JBoss</keyword> <keyword>JBoss Tools</keyword> <keyword>JBDS</keyword> - <keyword>BIRT</keyword> <keyword>BIRT Plugin</keyword> </keywordset> </chapterinfo> @@ -20,11 +18,10 @@ <section> <title>What is BIRT?</title> - <para>BIRT plugin for JBoss Developer Studio is an Eclipse-based open source reporting - system for web applications based on Java and J2EE. BIRT consists of two main - components: a report designer based on Eclipse, and a runtime component that can be - added to your app server. BIRT also offers a charting engine that lets you add charts to - your own Web application.</para> + <para>BIRT plugin is an Eclipse-based open source reporting system for web applications + based on Java and J2EE. BIRT consists of two main components: a report designer based on + Eclipse, and a runtime component that can be added to your app server. BIRT also offers + a charting engine that lets you add charts to your own Web application.</para> <para>With the help of BIRT you can generate a great number of reports to be used in your application:</para> @@ -46,19 +43,75 @@ </listitem> </itemizedlist> - <para>In this guide we provide you with the information on BIRT Designer which allows to - create a report much faster and with far fewer errors to spare your time.</para> + <para>You can find more detailed information on the BIRT plugin, its report types and + anatomy on the <ulink url="http://www.eclipse.org/birt/phoenix/intro/">BIRT Homepage</ulink>.</para> - <literallayout> </literallayout> - <para>You can find detailed information on the BIRT report types and anatomy here: <ulink - url="http://www.eclipse.org/birt/phoenix/intro/">JBoss BIRT</ulink></para> + <para>To understand the basic BIRT concepts and to know how to create a basic BIRT report, + refer to the <ulink url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT + Tutorials</ulink>. What extensions <property>JBoss Tools</property> provides for + Eclipse BIRT you&apos;ll find out in the next sections.</para> + </section> + <section> + <title>JBoss BIRT Integration Functionality Overview</title> - <para>All JBoss Developer Studio/JBoss Tools documentation you can find on<ulink - url="http://docs.jboss.org/tools/">documentation release page</ulink>.</para> - <para>The latest documentation builds are available on <ulink - url="http://download.jboss.org/jbosstools/nightly-docs/">doc... nightly builds page</ulink>.</para> + <para>This reference guide describes the one module of the <property>JBoss Tools</property> project which + performs the integration with BIRT. The integration includes the following functionalities:</para> + <itemizedlist> + <listitem> + <para>Hibernate ODA driver that includes a dialog to create HQL queries with + syntax-highlighting, content-assist, formatting as well as other functionalities + available in the HQL editor. There is also a possibility to add + parameters.</para> + </listitem> + <listitem> + <para>possibility to add JBoss BIRT functionality to the standard Seam web + project</para> + </listitem> + <listitem> + <para>BIRT JSF/Seam control</para> + </listitem> + <listitem> + <para>deployment of BIRT reports within web projects (Seam, JSF, etc.)</para> + </listitem> + </itemizedlist> + <para>To enable <property>JBoss Tools</property> integration with BIRT you are intended to + have the next:</para> + <itemizedlist> + <listitem> + <para>Eclipse with <property>JBoss Tools</property> + installed (how to install <property>JBoss Tools</property> on Eclipse, what + dependences and versions requirements are needed reed in the <link + linkend="http://download.jboss.org/jbosstools/nightly-docs/en/Gettin... + >JBoss Tools Installation</link> section)</para> + </listitem> + <listitem> + <para>BIRT Report Designer (BIRT Report Designer 2.3.2 + you can download from <ulink + url="http://www.eclipse.org/downloads/download.php?file=/birt/downlo... + >Eclipse downloads site</ulink>)</para> + </listitem> + <listitem> + <para>BIRT Web Tools Integration ( BIRT WTP Integration 2.3.2 you can download from + <ulink + url="http://www.eclipse.org/downloads/download.php?file=/birt/downlo... + >Eclipse downloads site</ulink>)</para> + </listitem> + </itemizedlist> + + <note> + <title>Note:</title> + <para>Versions of BIRT framework and BIRT WTP integration should be no less than RC4 in + order to the BIRT facet works correctly.</para> + </note> </section> + <section id="birt_plugin_rel_resources"> + <title>Other Relevant Resources on the Topic</title> + + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/too... in the corresponding release directory.</para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">htt... + </section> + </chapter> Modified: branches/jbosstools-3.0.x/birt/docs/pom.xml =================================================================== --- branches/jbosstools-3.0.x/birt/docs/pom.xml 2009-05-11 14:40:45 UTC (rev 15154) +++ branches/jbosstools-3.0.x/birt/docs/pom.xml 2009-05-11 15:18:11 UTC (rev 15155) @@ -86,6 +86,11 @@ <version>1.1.0</version> <type>jdocbook-style</type> </dependency> + <dependency> + <groupId>org.apache.xmlgraphics</groupId> + <artifactId>fop</artifactId> + <version>0.95</version> + </dependency> </dependencies> <configuration>