Documented: ofbiz-plugins / Birt, review existing adoc and migration for

Help docbook file to asciidoc (OFBIZ-11587)

* add license in each file, and remove trailing space
* better numberer list management
* add section Birt in Ofbiz user screen with help migrated file
This commit is contained in:
holivier
2020-07-20 15:54:00 +02:00
parent a321e5f49f
commit bf48bcb098
7 changed files with 326 additions and 167 deletions
@@ -1,23 +1,39 @@
=== Report creation
////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
==== Introduction
http://www.apache.org/licenses/LICENSE-2.0
NOTE: This feature will begin to be officially available with the R17.12 branch first release
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
=== Report creation
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
service. A flexible report is created from a Report Master (content REPORT_MASTER), and an optional XML override of the
parent form.
==== Introduction
==== Pre-requisite
NOTE: This feature will begin to be officially available with the R17.12 branch first release
* OFBiz framework
* The Birt plugin
* The BIRT Report Designer: <<#_using_the_birt_report_designer,Using the Birt Report Designer>>
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
service. A flexible report is created from a Report Master (content REPORT_MASTER), and an optional XML override of the
parent form.
'''
==== Pre-requisite
* 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]
==== How to do
. 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]
@@ -26,54 +42,54 @@ parent form.
** 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.
Once the form is validated, OFBiz will show you the "Edit Report" screen.
image::Edit-Report-screen.png[Edit Report screen]
image::Edit-Report-screen.png[Edit Report screen]
==== Report information
==== Report information
This first panel allows you to change the report description and status. Actually it does not make sense changing the
status to published before having downloaded the .rptdesign file (Birt Report Designer file) from the server (in
database), edited and uploaded it back to the server. This is explained in the section below. Changing the status allows
users to use your reports. But if you publish without any change the report will render as empty.
This first panel allows you to change the report description and status. Actually it does not make sense changing the
status to published before having downloaded the .rptdesign file (Birt Report Designer file) from the server (in
database), edited and uploaded it back to the server. This is explained in the section below. Changing the status allows
users to use your reports. But if you publish without any change the report will render as empty.
==== The .rptdesign report file: download, edit, upload and publish it
==== The .rptdesign report file: download, edit, upload and publish it
To really use the report you need to download the .rptdesign file from the server in a location from where you can edit
it with the BIRT Report Designer. So you need to install first the BIRT Report Designer. Then you can edit the
.rptdesign file in the BIRT Report Designer. For that refer to <<#_using_the_birt_report_designer,Using the Birt Report
Designer>>.
To really use the report you need to download the .rptdesign file from the server in a location from where you can edit
it with the BIRT Report Designer. So you need to install first the BIRT Report Designer. Then you can edit the
.rptdesign file in the BIRT Report Designer. For that refer to <<#_using_the_birt_report_designer,Using the Birt Report
Designer>>.
===== Editing the downloaded file
===== Editing the downloaded file
Once you installed the BIRT Report Designer and have downloaded the .rptdesign file, you can edit it with the Birt
Report Designer. When you have edited it suiting your needs you must upload it to the server for your changes to be
taken into account by OFBiz.
Once you installed the BIRT Report Designer and have downloaded the .rptdesign file, you can edit it with the Birt
Report Designer. When you have edited it suiting your needs you must upload it to the server for your changes to be
taken into account by OFBiz.
*This is when things begin to be really interesting*. You can then test your report using the "Preview" panel. There you
can temporarily filter the result, and use the export format you prefer, once done click "Send". You can then decide to
change the report content in the Birt Report Designer again or keep your changes. Once done in the Birt Report Designer,
simply select the changed file to upload, and upload it again. You can re-test your changes and continue until you
really get what you want! You can then publish the report to allow users to select and use it. There are 2 ways to
publish a report from the "Manage reports" screen or directly in the "Report information" panel. We will see the "Manage
reports" screen below.
*This is when things begin to be really interesting*. You can then test your report using the "Preview" panel. There you
can temporarily filter the result, and use the export format you prefer, once done click "Send". You can then decide to
change the report content in the Birt Report Designer again or keep your changes. Once done in the Birt Report Designer,
simply select the changed file to upload, and upload it again. You can re-test your changes and continue until you
really get what you want! You can then publish the report to allow users to select and use it. There are 2 ways to
publish a report from the "Manage reports" screen or directly in the "Report information" panel. We will see the "Manage
reports" screen below.
==== Filters Overriding
==== Filters Overriding
You may want to overide the default filters. You can then use the Xml "Override filters" panel to override and
personnalize the form, once done click "Save". If you ignore that step, it will *NOT* prevent the report creation, *it
is already done*, it will just be with the generic filtering form inherited from the master from.
You may want to overide the default filters. You can then use the Xml "Override filters" panel to override and
personnalize the form, once done click "Save". If you ignore that step, it will *NOT* prevent the report creation, *it
is already done*, it will just be with the generic filtering form inherited from the master from.
NOTE: if no preview is available, it is usually due to a mistake in the master form code. You can edit it in the
database.
NOTE: if no preview is available, it is usually due to a mistake in the master form code. You can edit it in the
database.
==== Manage reports
==== Manage reports
The "Manage reports" button get you to a screen which allows to edit (get back to current page), publish or delete a
report.
The "Manage reports" button get you to a screen which allows to edit (get back to current page), publish or delete a
report.
==== Use a report
==== Use a report
Users can select and use any published report from that screen. When they select a report they then get the same
"Preview" Panel and can do the same things than in the "Edit Report" screen. Refer users to
Users can select and use any published report from that screen. When they select a report they then get the same
"Preview" Panel and can do the same things than in the "Edit Report" screen. Refer users to
@@ -0,0 +1,75 @@
////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
= BIRT in OFbiz User Interface
Welcome to OFBiz BIRT component. +
The part installed within OFBiz allows you to run the reports which are prepared using Eclipse with the BIRT plugin installed.
This is a short document to help you get started using BIRT to make a report.
As a demo we have prepared a an example report. +
Look at the http://eclipse.org/birt/phoenix/[Eclipse BIRT web site] for more information.
There is also a new feature (2017) which allows you to dynamically create Birt reports, and allow your users to customise them:
the <<_ofbiz_flexible_reports>>.
== PDF tab
When you click on this tab.
It will render the example report in a PDF format
== Send any format through Mail tab
When you click on this tab.
It will show a form that can send the report per email.
== Chart tab
When you click on this tab.
An example chart will render in a PDF format
== Examine the Example Report
The example report design that run in OFBiz is in the file component://birt/webapp/birt/report/example.rptdesign.
When you have started Eclipse BIRT, open this document.
This report show how a report receives data from OFBiz through Scripted Data Source using the OFBiz delegator. +
This report has the scripted data source name "OFBiz" and the data set that use the script data source name is called "Product".
Open the script editor for Product data set, it uses the delegator object query data from the Product entity.
A report that runs on the OFBiz platform can use the delegator object, dispatcher object, security object and classpath of
OFBiz environment in the script.
== How do I send parameter to report?
If a report is to be rendered through a view map, you can send a parameter through attribute of the request object,
the attribute's name is "birtParameters" which is a map.
If a report is to be rendered through an e-mail, you can send the parameter through the service's parameter name called
birtParameters.
== Which are the supported content types?
* Excel (.xls)
* Excel (.xlsx)
* LibreOffice Calc (.ods)
* LibreOffice Impress (.odp)
* LibreOffice Writer (.odt)
* Pdf (.pdf)
* Postscript (.ps)
* Powerpoint (.ppt)
* Powerpoint (.pptx)
* Text (.html)
* Word (.doc)
* Word (.docx)
@@ -1,21 +1,37 @@
=== Using a flexible report
////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
==== Introduction
http://www.apache.org/licenses/LICENSE-2.0
NOTE: this feature will be officially available with the R17.12 branch first release
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
=== Using a flexible report
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.
==== Introduction
==== Pre-requisite
NOTE: this feature will be officially available with the R17.12 branch first release
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.
==== Pre-requisite
* OFBiz
* The Birt plugin
* Pre-published reports created from report masters
==== Using the report
==== Using the report
. go to the Birt component or to another page harboring reports.
. In the Birt component, click "Use a report".
. Select your report and hit "Send".
@@ -1,12 +1,30 @@
////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
=== Report master creation
==== Introduction
NOTE: this feature will be officially available with the R17.12 branch first release
A report master is an OFBiz content which allows a user to generate data reports.
It defines data connexion, and a general filtering form for data.
It can be based on an entity, a dedicated service, or in a wider sense on any shape
A report master is an OFBiz content which allows a user to generate data reports.
It defines data connexion, and a general filtering form for data.
It can be based on an entity, a dedicated service, or in a wider sense on any shape
a data connexion can take and return back a map.
==== Pre-requisite
@@ -15,19 +33,19 @@ a data connexion can take and return back a map.
* Birt plugin
==== Report Master based on an entity/view
. 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
. Add the informations about this Master in the database using the file
plugins/birt/data/BirtMasterData.xml
+
[source,xml]
----
<DataResource dataResourceId="DR_MASTER_EXAMPLE" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="FORM_COMBINED" />
@@ -42,13 +60,13 @@ plugins/birt/data/BirtMasterData.xml
<ContentAttribute contentId="CTNT_MASTER_EXAMPLE" attrName="Entity" attrValue="Example"/>
----
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,
+
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
. Add in the file content/config/contentEntityLabels.xml the Property that will allow translation
for your report master description.
+
[source,xml]
----
<property key="Content.description.CTNT_MASTER_EXAMPLE">
@@ -60,41 +78,48 @@ for your report master description.
Your Report Master is created ! You can now create reports using it.
==== Report Master based on a service
In plugins/birt/src/main/java/org/apache/ofbiz/birt/flexible/BirtMasterReportServices.java there is 2 sets of dedicated services (see examples there)
. In each set the first service, will return 4 items:
** an object of type Map<String, String> called dataMap.
*Keys*: data field names. *Values*: data types (OFBiz types).
** an object of type Map<String, String> called fieldDisplayLabels.
*Keys*: data field names. *Values*: the names displayed to the user.
This output is optional, should it be missing, the keys will be displayed.
** an object of type Map<String, String> called filterMap.
*Keys*: data filtering field names (exact names used for the form fields).
*Values*: data type (OFBiz type).
This output is optional, if missing, filters can not be displayed on the report.
** an object of type Map<String, String> called filterDisplayLabels.
*Keys*: data filtering field names (exact names used for the form fields).
*Values*: names to be displayed to the user.
This output is optional, should it be missing, the keys will be displayed.
. The second service will actually get the data. It receives an object (Object type) called reportContext.
From this object, you can obtain the map parameters using the following code:
** an object of type Map<String, String> called *dataMap*.
*** *Keys*: data field names.
*** *Values*: data types (OFBiz types).
** an object of type Map<String, String> called *fieldDisplayLabels*.
*** *Keys*: data field names.
*** *Values*: the names displayed to the user.
+
This output is optional, should it be missing, the keys will be displayed.
** an object of type Map<String, String> called *filterMap*.
*** *Keys*: data filtering field names (exact names used for the form fields).
*** *Values*: data type (OFBiz type).
+
This output is optional, if missing, filters can not be displayed on the report.
** an object of type Map<String, String> called *filterDisplayLabels*.
*** *Keys*: data filtering field names (exact names used for the form fields).
*** *Values*: names to be displayed to the user.
+
This output is optional, should it be missing, the keys will be displayed.
. The second service will actually get the data. It receives an object (Object type) called reportContext. +
From this object, you can obtain the map parameters using the following code:
+
[source,java]
----
Map<String, Object> parameters = UtilGenerics.checkMap(reportContext.getParameterValue("parameters"));
----
This Map will give access fields of the filtering form.
This service will return a list of type List<GenericValue>, containing the data.
+
This Map will give access fields of the filtering form. +
This service will return a list of type List<GenericValue>, containing the data. +
A Map<String, Object> would also do.
Then,
. create the parent form in the file plugins/birt/widget/birt/BirtMasterForms.xml.
Field names created here must be the names used on the Map parameters of the previous service,
Field names created here must be the names used on the Map parameters of the previous service,
and also corresponding to the map filterMap.
+
[source,xml]
----
<form name="CTNT_MASTER_TURNOVER" type="single" extends="AbstractFlexibleReportSearchForm">
@@ -104,9 +129,9 @@ and also corresponding to the map filterMap.
<field name="productStoreId"><lookup target-form-name="LookupProductStore"/></field>
</form>
----
[start=2]
. Create the master in database following.
. Create the master in database following.
+
[source,xml]
----
<CustomMethod customMethodId="CM_FB_TURNOVER" customMethodTypeId="FLEXIBLE_BIRT" customMethodName="flexibleReportTurnOver" description="service to resolve invoice for turnover report domain"/>
@@ -125,10 +150,10 @@ and also corresponding to the map filterMap.
<ContentAttribute contentId="CTNT_MASTER_TURNOVER" attrName="Service" attrValue="default"/>
----
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,
+
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.
@@ -1,71 +1,89 @@
=== Using the Birt Report Designer
////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
==== Introduction
http://www.apache.org/licenses/LICENSE-2.0
NOTE: this feature will be officially available with the R17.12 branch first release
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
=== Using the Birt Report Designer
The creation of a flexible report goes through a design step of the initial flexible report output under the Birt Report
Designer.
==== Introduction
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.
NOTE: this feature will be officially available with the R17.12 branch first release
==== Installing the BIRT Report Designer
The creation of a flexible report goes through a design step of the initial flexible report output under 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.
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.
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...
==== Installing the BIRT Report Designer
==== Different areas of the screen and their role
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.
===== Navigator - Report Builder
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...
This is where you should find the .rptdesign files you downloaded.
==== Different areas of the screen and their role
image::Report-Builder.png[Report Builder]
===== Navigator - Report Builder
===== Data Explorer
This is where you should find the .rptdesign files you downloaded.
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.
image::Report-Builder.png[Report Builder]
image::Data-Explorer.png[Data Explorer]
===== Data Explorer
===== Palette
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.
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.
image::Data-Explorer.png[Data Explorer]
image::Palette.png[Palette]
===== Palette
===== Tabs
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.
At the right bottom of the window is a series of five tabs.
image::Palette.png[Palette]
We will use two:
===== Tabs
At the right bottom of the window is a series of five tabs.
We will use two:
* Layout, which will allow most of the design.
* Master Page, which will give access by its owners to standard parameters such as the orientation or size of the report.
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.
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.
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.
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.
. Insert a table (Table) in the report \-> OK
. Right-click on the table \-> Edit Data Binding, select all fields
@@ -77,40 +95,40 @@ details for each category, then to aggregate certain fields, etc.
** A group detail line
** A footer of the group
** A global footer line
. 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.
. 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
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
(made up of different data fields), a possible filter on the data lines, and an aggregation function, eg:
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:
image::Aggregation-builder.png[Aggregation builder]
image::Aggregation-builder.png[Aggregation builder]
====== 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.
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.
image::Expression-builder.png[Expression builder]
image::Expression-builder.png[Expression builder]
Footer lines often allow you to place aggregations, such as sums on the group or table rows, eg
Footer lines often allow you to place aggregations, such as sums on the group or table rows, eg
image::Design-with-break-complete.png[Design with break complete]
image::Design-with-break-complete.png[Design with break complete]
WARNING: any unused line must be deleted, otherwise it generates white spaces on the report.
WARNING: any unused line must be deleted, otherwise it generates white spaces on the report.
==== Layout Management
==== Layout Management
===== General settings
===== General settings
Right button leads to Properties Editor tab at bottom. Then click on the Master Page tab, just above. In the Property
Editor you will see a series of general properties that will allow you to modify the general form of the report.
Right button leads to Properties Editor tab at bottom. Then click on the Master Page tab, just above. In the Property
Editor you will see a series of general properties that will allow you to modify the general form of the report.
===== Styles
===== Styles
By right-clicking on any item in the table, you have access to the menu of styles. From there they can be edited,
applied, created. A style can be applied to the whole picture, to a row or column, to a cell, or to an element in that
cell (text, data, ...).
By right-clicking on any item in the table, you have access to the menu of styles. From there they can be edited,
applied, created. A style can be applied to the whole picture, to a row or column, to a cell, or to an element in that
cell (text, data, ...).
+17 -10
View File
@@ -16,9 +16,9 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
= Birt Apache OFBiz® plugin
= Birt OFBiz® plugin
The Apache OFBiz Project
Release 17.12
Release trunk
:imagesdir: ./images
ifdef::backend-pdf[]
:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center]
@@ -32,13 +32,20 @@ One of the functionalities of the birt plugin are the "OFBiz Flexible Reports"
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=+0]
include::_include/bt-using the birt report designer.adoc[leveloffset=+0]
include::_include/bt-report master creation.adoc[leveloffset=+0]
== User documentation
include::_include/bt-how to use flexible reports.adoc[leveloffset=+0]
include::_include/bt-help.adoc[leveloffset=+1]
=== Technical Documentation
include::_include/bt-creating reports.adoc[leveloffset=+1]
include::_include/bt-using the birt report designer.adoc[leveloffset=+1]
include::_include/bt-report master creation.adoc[leveloffset=+1]
=== User documentation
include::_include/bt-how to use flexible reports.adoc[leveloffset=+1]
+2
View File
@@ -27,6 +27,8 @@ endif::[]
:toc:
:sectnums:
include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1]
include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1]
include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1]