Author: jleroux
Date: Thu Nov 22 17:59:53 2018
New Revision: 1847196
URL: http://svn.apache.org/viewvc?rev=1847196&view=rev
Log:
Documented: no functional changes
Last touch on Birt doc
Modified:
ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-creating
reports.adoc
ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-report master
creation.adoc
ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-using the birt
report designer.adoc
ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/birt.adoc
Modified: ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-creating
reports.adoc
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-creating%20reports.adoc?rev=1847196&r1=1847195&r2=1847196&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-creating
reports.adoc (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-creating
reports.adoc Thu Nov 22 17:59:53 2018
@@ -1,6 +1,8 @@
=== Report creation
-==== Introduction NOTE: This feature will begin to be officially available
with the R17.12 branch first release
+==== Introduction
+
+NOTE: This feature will begin to be officially available with the R17.12
branch first release
A flexible report is an OFBiz content of FLEXIBLE_REPORT type that allows a
final user to make use of the reporting
module to obtain flexible reports, ie reports which are created from an entity
or view definition and even from a
@@ -9,26 +11,20 @@ parent form.
==== Pre-requisite
-* OFBiz framework * The Birt plugin * The BIRT Report Designer:
<<#_using_the_birt_report_designer,Using the Birt Report
-Designer>>
+* OFBiz framework
+* The Birt plugin
+* The BIRT Report Designer: <<#_using_the_birt_report_designer,Using the Birt
Report Designer>>
-* OFBiz framework
-* The Birt plugin
-* The BIRT Report Designer: <<#_using_the_birt_report_designer,Using the Birt
Report Designer>>
+'''
. Get to Birt component in OFBiz image:Birt-Menus.png[Birt menus]
-
-. Click on the "Flexible Report" menu (varies depending on themes) . Click on
the "Generate report" button, you get to
-this screen: . Fill the form: image:Example-Report.png[Example Report]
-
. Click on the "Flexible Report" menu (varies depending on themes)
. Click on the "Generate report" button, you get to this screen:
. Fill the form: image:Example-Report.png[Example Report]
-
- ** The list "Choose report topic" will let you choose among predefined report
masters your topic of interest.
- ** The report name is a simple short name from which the file name will be
generated.
- ** The description is a short description which will allow you to recognise
the report and its topic.
- ** The box "Generate filters in design" will add in the design the
visualisation of the filters filled in the filtering form.
+** The list "Choose report topic" will let you choose among predefined report
masters your topic of interest.
+** The report name is a simple short name from which the file name will be
generated.
+** The description is a short description which will allow you to recognise
the report and its topic.
+** The box "Generate filters in design" will add in the design the
visualisation of the filters filled in the filtering form.
Once the form is validated, OFBiz will show you the "Edit Report" screen.
Modified: ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-report
master creation.adoc
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-report%20master%20creation.adoc?rev=1847196&r1=1847195&r2=1847196&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-report master
creation.adoc (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-report master
creation.adoc Thu Nov 22 17:59:53 2018
@@ -18,14 +18,13 @@ a data connexion can take and return bac
. Create or choice a database entity or view
. Create the general filtering form within the file
plugins/birt/widget/birt/BirtMasterForms.xml. The only informations to be
changed are entity-name and form name.
-
[source,xml]
----
<form name="CTNT_MASTER_EXAMPLE" type="single"
extends="AbstractFlexibleReportSearchForm">
<auto-fields-entity entity-name="Example" default-field-type="find"/>
</form>
----
-
+[start=3]
. Add the informations about this Master in the database using the file
plugins/birt/data/BirtMasterData.xml
@@ -46,7 +45,7 @@ plugins/birt/data/BirtMasterData.xml
The form in the database is the form that will allow users to change form
parameters.
You can add any field you desire. Some field names are though reserved:
reportContentId, overrideFilters,
entityViewName, birtContentType.
-
+[start=4]
. Add in the file content/config/contentEntityLabels.xml the Property that
will allow translation
for your report master description.
@@ -105,7 +104,7 @@ and also corresponding to the map filter
<field name="productStoreId"><lookup
target-form-name="LookupProductStore"/></field>
</form>
----
-
+[start=2]
. Create the master in database following.
[source,xml]
@@ -129,7 +128,7 @@ and also corresponding to the map filter
The form in the database is the form that will allow users to change form
parameters.
You can add any field you desire. Some field names are reserved:
reportContentId, overrideFilters,
entityViewName, birtContentType.
-
+[start=3]
. Import these data in the base using Webtools XML import (or the longer
"gradlew 'ofbiz -l readers=seed,ext' command).
. Add in the file content/config/contentEntityLabels.xml the Property which
will translate your report Master description.
Modified: ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-using
the birt report designer.adoc
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-using%20the%20birt%20report%20designer.adoc?rev=1847196&r1=1847195&r2=1847196&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-using the birt
report designer.adoc (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/_include/bt-using the birt
report designer.adoc Thu Nov 22 17:59:53 2018
@@ -80,7 +80,6 @@ details for each category, then to aggre
. 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.
image::Design-with-break.png[Design with break]
-
====== Construction of aggregation
The aggregations may be on the whole table, or only on a group. They are
characterized by an expression to aggregate
Modified: ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/birt.adoc
URL:
http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/birt.adoc?rev=1847196&r1=1847195&r2=1847196&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/birt.adoc (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/src/docs/asciidoc/birt.adoc Thu Nov 22
17:59:53 2018
@@ -28,7 +28,8 @@ One of the functionalities of the birt p
NOTE: This feature will begin to be officially available with the R17.12
branch first release
-There is an anounce with some history in the OFBiz blog:
https://blogs.apache.org/ofbiz/entry/the-birt-flexible-reports-a[Reporting in
Apache OFBiz® and the OFBiz Flexible Reports]
+There is an anounce with some history in the OFBiz blog:
+https://blogs.apache.org/ofbiz/entry/the-birt-flexible-reports-a[Reporting in
Apache OFBiz® and the OFBiz Flexible Reports]
=== Technical Documentation
include::_include/bt-creating reports.adoc[leveloffset=+1]
