You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by jl...@apache.org on 2017/03/26 18:42:05 UTC
svn commit: r1788762 - in /ofbiz/ofbiz-plugins/trunk/birt/documents: How to
use flexible reports.md How to use flexible reports.md.html Using the Birt
Report Designer.md Using the Birt Report Designer.md.html
Author: jleroux
Date: Sun Mar 26 18:42:05 2017
New Revision: 1788762
URL: http://svn.apache.org/viewvc?rev=1788762&view=rev
Log:
Documented: Complete Birt Flexible Reports documentation
(OFBIZ-9188)
Fixes titles and indentation issues
Modified:
ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md
ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md.html
ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md
ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md.html
Modified: ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/documents/How%20to%20use%20flexible%20reports.md?rev=1788762&r1=1788761&r2=1788762&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md Sun Mar 26 18:42:05 2017
@@ -1,4 +1,4 @@
-# For users: using a flexible report#
+# Using a flexible report - User #
## Introduction ##
A flexible report is an OFBiz content of FLEXIBLE_REPORT type which allows the final user to obtain reports using the Birt reporting module. It will be produced at a specific time of your choosing, with your chosen output format, filtering the data with a few parameters defined during report design creation.
Modified: ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md.html
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/documents/How%20to%20use%20flexible%20reports.md.html?rev=1788762&r1=1788761&r2=1788762&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md.html (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/documents/How to use flexible reports.md.html Sun Mar 26 18:42:05 2017
@@ -8,7 +8,7 @@
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
-<h1 id="for-users-using-a-flexible-report">For users: using a flexible report</h1>
+<h1 id="using-a-flexible-report---user">Using a flexible report - User</h1>
<h2 id="introduction">Introduction</h2>
<p>A flexible report is an OFBiz content of FLEXIBLE_REPORT type which allows the final user to obtain reports using the Birt reporting module. It will be produced at a specific time of your choosing, with your chosen output format, filtering the data with a few parameters defined during report design creation.</p>
<h2 id="pre-requisite">Pre-requisite</h2>
Modified: ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/documents/Using%20the%20Birt%20Report%20Designer.md?rev=1788762&r1=1788761&r2=1788762&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md Sun Mar 26 18:42:05 2017
@@ -1,26 +1,27 @@
-# Introduction #
+# Using the Birt Report Designer - Admin/Super-User #
+## Introduction ##
The creation of a flexible report goes through a design step of the initial flexible report output under the Birt Report Designer.
This document describes the simplest designs to connect to the data. It is not exhaustive, and simply attempts to cover basic needs. You will find much more documentation online. In our approach, the connection to the data is generated automatically by OFBiz, only the design part of the report will be discussed.
-### Installing the BIRT Report Designer ###
+## Installing the BIRT Report Designer ##
Installing the BIRT Report Designer is easy. If you use Eclipse, you can include it as a plugin. You can also install the whole BIRT Report Designer. I use Eclipse but I prefer the second way, to not mix things. So simply download and install the whole all-in-one thing. Or install the plugin if you prefer and use its "Report Design" view which allows to edit * .rptdesign files.
>_Note_: if you installed the BIRT Report Designer under say, a Birt directory, then by default the reports will be accessed from the Birt\workspace\Report Builder directly and this is where you should put the .rptdesign files when downloading them. Your mileage may wary...
-# Different areas of the screen and their role #
-## Navigator - Report Builder ##
+## Different areas of the screen and their role ##
+### Navigator - Report Builder ###
This is where you will find the
-## Data Explorer ##
+### Data Explorer ###
The Data Explorer defaults to the right of your screen. It gives you access to two things. The data fields available for the report, and the filter fields that can be used for this report.
-## Palette ##
+### Palette ###
The palette provides the various tools you can insert in the report. Simple text, image, table of data, layout table, graph, aggregation, etc. All objects are added to the report by drag & drop.
-## Tabs ##
+### Tabs ###
At the right bottom of the window is a series of five tabs.
We will use two:
@@ -30,10 +31,10 @@ We will use two:
The preview is not accessible because it can not be executed outside of OFBiz. Any changes to the scripts will be erased during the upload in OFBiz.
-## Simple design without break ##
+### Simple design without break ###
The simplest possible design is to insert in a table (table in the palette), a part or all of the data set data fields. To do this, right-click on Data Set in the Data Explorer -> Insert in Layout, and then select the fields you want to see appear.
-## Simple design with break ##
+### Simple design with break ###
A break is a collection of data made by Birt from the data. It permits to classify according to a field, and to give details for each category, then to aggregate certain fields, etc.
1. Insert a table (Table) in the report -> OK
@@ -48,10 +49,10 @@ A break is a collection of data made by
* A global footer line
6. Then insert some elements in the design: in the global header, everything that does not depend on the group, for example the title of the report. In the header of the group, everything that is common to the whole group and that you want to see in its title. In the details, the fields that may appear for each group line. As in the image below, the fields might be inserted by Copy/Paste from the Data Set, and titles via a text element of the palette. You can add lines and columns by right clicking on the end of the line (gray rectangle when the table is selected), etc. 
-## Construction of aggregation ##
+#### Construction of aggregation ####
The aggregations may be on the whole table, or only on a group. They are characterized by an expression to aggregate (made up of different data fields), a possible filter on the data lines, and an aggregation function, eg:
-### Expression builder ###
+#### Expression builder ####
The *fx* (for expression and filter) buttons are used to open a complex expression construction window. It is possible to use predefined functions, Javascript, data fields, already built aggregations, and so on. This window can also be used by including a data element, which allows to construct non-aggregated data expressions.
Modified: ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md.html
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/documents/Using%20the%20Birt%20Report%20Designer.md.html?rev=1788762&r1=1788761&r2=1788762&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md.html (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/documents/Using the Birt Report Designer.md.html Sun Mar 26 18:42:05 2017
@@ -8,24 +8,25 @@
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
-<h1 id="introduction">Introduction</h1>
+<h1 id="using-the-birt-report-designer---adminsuper-user">Using the Birt Report Designer - Admin/Super-User</h1>
+<h2 id="introduction">Introduction</h2>
<p>The creation of a flexible report goes through a design step of the initial flexible report output under the Birt Report Designer.</p>
<p>This document describes the simplest designs to connect to the data. It is not exhaustive, and simply attempts to cover basic needs. You will find much more documentation online. In our approach, the connection to the data is generated automatically by OFBiz, only the design part of the report will be discussed.</p>
-<h3 id="installing-the-birt-report-designer">Installing the BIRT Report Designer</h3>
+<h2 id="installing-the-birt-report-designer">Installing the BIRT Report Designer</h2>
<p>Installing the BIRT Report Designer is easy. If you use Eclipse, you can include it as a plugin. You can also install the whole BIRT Report Designer. I use Eclipse but I prefer the second way, to not mix things. So simply download and install the whole all-in-one thing. Or install the plugin if you prefer and use its "Report Design" view which allows to edit * .rptdesign files.</p>
<blockquote>
<p><em>Note</em>: if you installed the BIRT Report Designer under say, a Birt directory, then by default the reports will be accessed from the BirtBuilder directly and this is where you should put the .rptdesign files when downloading them. Your mileage may wary...</p>
</blockquote>
-<h1 id="different-areas-of-the-screen-and-their-role">Different areas of the screen and their role</h1>
-<h2 id="navigator---report-builder">Navigator - Report Builder</h2>
-<p>This is where you will find the ## Data Explorer ## The Data Explorer defaults to the right of your screen. It gives you access to two things. The data fields available for the report, and the filter fields that can be used for this report.</p>
+<h2 id="different-areas-of-the-screen-and-their-role">Different areas of the screen and their role</h2>
+<h3 id="navigator---report-builder">Navigator - Report Builder</h3>
+<p>This is where you will find the ### Data Explorer ### The Data Explorer defaults to the right of your screen. It gives you access to two things. The data fields available for the report, and the filter fields that can be used for this report.</p>
<div class="figure">
<img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Data%20Explorer.png?api=v2" alt="Data Explorer" />
<p class="caption">Data Explorer</p>
</div>
-<h2 id="palette">Palette</h2>
+<h3 id="palette">Palette</h3>
<p>The palette provides the various tools you can insert in the report. Simple text, image, table of data, layout table, graph, aggregation, etc. All objects are added to the report by drag & drop. <img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Palette.png?api=v2" alt="Palette" /></p>
-<h2 id="tabs">Tabs</h2>
+<h3 id="tabs">Tabs</h3>
<p>At the right bottom of the window is a series of five tabs.</p>
<p>We will use two:</p>
<ul>
@@ -33,9 +34,9 @@
<li>Master Page, which will give access by its owners to standard parameters such as the orientation or size of the report.</li>
</ul>
<p>The preview is not accessible because it can not be executed outside of OFBiz. Any changes to the scripts will be erased during the upload in OFBiz.</p>
-<h2 id="simple-design-without-break">Simple design without break</h2>
+<h3 id="simple-design-without-break">Simple design without break</h3>
<p>The simplest possible design is to insert in a table (table in the palette), a part or all of the data set data fields. To do this, right-click on Data Set in the Data Explorer -> Insert in Layout, and then select the fields you want to see appear.</p>
-<h2 id="simple-design-with-break">Simple design with break</h2>
+<h3 id="simple-design-with-break">Simple design with break</h3>
<p>A break is a collection of data made by Birt from the data. It permits to classify according to a field, and to give details for each category, then to aggregate certain fields, etc.</p>
<ol style="list-style-type: decimal">
<li>Insert a table (Table) in the report -> OK</li>
@@ -54,8 +55,8 @@
<ol start="6" style="list-style-type: decimal">
<li>Then insert some elements in the design: in the global header, everything that does not depend on the group, for example the title of the report. In the header of the group, everything that is common to the whole group and that you want to see in its title. In the details, the fields that may appear for each group line. As in the image below, the fields might be inserted by Copy/Paste from the Data Set, and titles via a text element of the palette. You can add lines and columns by right clicking on the end of the line (gray rectangle when the table is selected), etc. <img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Design%20with%20break.png?api=v2" alt="Design with break" /></li>
</ol>
-<h2 id="construction-of-aggregation">Construction of aggregation</h2>
-<p>The aggregations may be on the whole table, or only on a group. They are characterized by an expression to aggregate (made up of different data fields), a possible filter on the data lines, and an aggregation function, eg: <img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Aggregation%20builder.png?api=v2" alt="Aggregation builder" /> ### Expression builder ### The <em>fx</em> (for expression and filter) buttons are used to open a complex expression construction window. It is possible to use predefined functions, Javascript, data fields, already built aggregations, and so on. This window can also be used by including a data element, which allows to construct non-aggregated data expressions. <img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Expression%20builder.png?api=v2" alt="Expression builder" /></p>
+<h4 id="construction-of-aggregation">Construction of aggregation</h4>
+<p>The aggregations may be on the whole table, or only on a group. They are characterized by an expression to aggregate (made up of different data fields), a possible filter on the data lines, and an aggregation function, eg: <img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Aggregation%20builder.png?api=v2" alt="Aggregation builder" /> #### Expression builder #### The <em>fx</em> (for expression and filter) buttons are used to open a complex expression construction window. It is possible to use predefined functions, Javascript, data fields, already built aggregations, and so on. This window can also be used by including a data element, which allows to construct non-aggregated data expressions. <img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Expression%20builder.png?api=v2" alt="Expression builder" /></p>
<p>Footer lines often allow you to place aggregations, such as sums on the group or table rows, eg <img src="https://cwiki.apache.org/confluence/download/attachments/68720496/Design%20with%20break%20complete.png?api=v2" alt="Design with break complete" /></p>
<blockquote>
<p>Warning: any unused line must be deleted, otherwise it generates white spaces on the report.</p>