Author: jleroux
Date: Fri Nov 3 12:39:14 2017
New Revision: 1814171
URL: http://svn.apache.org/viewvc?rev=1814171&view=rev
Log:
Better structure for the wiki-files
Added:
ofbiz/tools/wiki-files/birt/
ofbiz/tools/wiki-files/birt/Creating reports.md.html (with props)
ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html (with
props)
ofbiz/tools/wiki-files/birt/Report master creation.md.html (with props)
ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html (with
props)
ofbiz/tools/wiki-files/demo/
ofbiz/tools/wiki-files/demo/README.md.html (with props)
ofbiz/tools/wiki-files/themes/
Removed:
ofbiz/tools/demo-backup/README.md.html
ofbiz/tools/wiki-files/Creating reports.md.html
ofbiz/tools/wiki-files/How to use flexible reports.md.html
ofbiz/tools/wiki-files/Report master creation.md.html
ofbiz/tools/wiki-files/Using the Birt Report Designer.md.html
Added: ofbiz/tools/wiki-files/birt/Creating reports.md.html
URL:
http://svn.apache.org/viewvc/ofbiz/tools/wiki-files/birt/Creating%20reports.md.html?rev=1814171&view=auto
==============================================================================
--- ofbiz/tools/wiki-files/birt/Creating reports.md.html (added)
+++ ofbiz/tools/wiki-files/birt/Creating reports.md.html Fri Nov 3 12:39:14
2017
@@ -0,0 +1,47 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta name="generator" content="pandoc" />
+ <title></title>
+ <style type="text/css">code{white-space: pre;}</style>
+</head>
+<body>
+<h1 id="report-creation---adminsuper-user">Report creation -
Admin/Super-User</h1>
+<h2 id="introduction">Introduction</h2>
+<p>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.</p>
+<h2 id="pre-requisite">Pre-requisite</h2>
+<ul>
+<li>OFBiz framework</li>
+<li>The Birt plugin</li>
+<li>The BIRT Report Designer</li>
+</ul>
+<h2 id="report-creation">Report creation</h2>
+<ol style="list-style-type: decimal">
+<li>Get to Birt component in OFBiz <img
src="https://cwiki.apache.org/confluence/download/attachments/68720496/Birt%20Menus.png?api=v2";
alt="Birt menus" /></li>
+<li>Click on the "Flexible Report" menu (varies depending on
themes)</li>
+<li>Click on the "Generate report" button, you get to this
screen:</li>
+<li>Fill the form: <img
src="https://cwiki.apache.org/confluence/download/attachments/68720496/Example%20Report.png?api=v2";
alt="Example Report" /></li>
+</ol>
+<ul>
+<li>The list "Choose report topic" will let you choose among
predefined report masters your topic of interest.</li>
+<li>The report name is a simple short name from which the file name will be
generated.</li>
+<li>The description is a short description which will allow you to recognise
the report and its topic.</li>
+<li>The box "Generate filters in design" will add in the design the
visualisation of the filters filled in the filtering form.</li>
+</ul>
+<p>Finally, if you don't find what you want, you will need to create a new
Report Master...</p>
+<p>Once the form is validated, OFBiz will show you the "Edit Report"
screen. <img
src="https://cwiki.apache.org/confluence/download/attachments/68720496/Edit%20Report%20screen.png?api=v2";
alt="Edit Report screen" /></p>
+<h2 id="report-information">Report information</h2>
+<p>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.</p>
+<h2 id="the-.rptdesign-report-file-donwload-edit-upload-and-publish-it">The
.rptdesign report file: donwload, edit, upload and publish it</h2>
+<p>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 the <a
href="https://svn.apache.org/repos/asf/ofbiz/ofbiz-plugins/trunk/birt/documents/Using%20the%20Birt%20Report%20Designer.md.html";>"Using
the Birt Report Designer.md.html" file</a>. You can also find the
Markdonw version in the same directory: ofbiz-framework/plugins/birt/documents
### 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.</p>
+<p><span style="color:red"><strong>This is when things begin to be really
interesting</strong>.</span> 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.</p>
+<h2 id="filters-overriding">Filters Overriding</h2>
+<p>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
<strong>NOT</strong> prevent the report creation, <strong>it is already
done</strong>, it will just be with the generic filtering form inherited from
the master from. ><em>Note</em>: if no preview is available, it is usually
due to a mistake in the master form code. You can edit it in the database.</p>
+<h2 id="manage-reports">Manage reports</h2>
+<p>The "Manage reports" button get you to a screen which allows to
edit (get back to current page), publish or delete a report.</p>
+<h2 id="use-a-report">Use a report</h2>
+<p>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</p>
+</body>
+</html>
Propchange: ofbiz/tools/wiki-files/birt/Creating reports.md.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/tools/wiki-files/birt/Creating reports.md.html
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/tools/wiki-files/birt/Creating reports.md.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html
URL:
http://svn.apache.org/viewvc/ofbiz/tools/wiki-files/birt/How%20to%20use%20flexible%20reports.md.html?rev=1814171&view=auto
==============================================================================
--- ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html (added)
+++ ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html Fri Nov 3
12:39:14 2017
@@ -0,0 +1,33 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta name="generator" content="pandoc" />
+ <title></title>
+ <style type="text/css">code{white-space: pre;}</style>
+</head>
+<body>
+<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>
+<ul>
+<li>OFBiz</li>
+<li>The Birt plugin</li>
+<li>Pre-published reports created from report masters</li>
+</ul>
+<h2 id="using-the-report">Using the report</h2>
+<ol style="list-style-type: decimal">
+<li>go to the Birt component or to another page harboring reports.</li>
+<li>In the Birt component, click "Use a report".</li>
+<li>Select your report and hit "Send".</li>
+<li>The next screen will allow you to filter your data through a set of
pre-defined criteria. Should you leave it empty, you will retrieve unfiltered
data.</li>
+<li>Select the desired export format</li>
+<li>Upon validation, your report is now loaded and can be saved.</li>
+</ol>
+<blockquote>
+<p><em>Note</em>: Report loading can be a bit long depending on the data
treatment</p>
+</blockquote>
+</body>
+</html>
Propchange: ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/tools/wiki-files/birt/Report master creation.md.html
URL:
http://svn.apache.org/viewvc/ofbiz/tools/wiki-files/birt/Report%20master%20creation.md.html?rev=1814171&view=auto
==============================================================================
--- ofbiz/tools/wiki-files/birt/Report master creation.md.html (added)
+++ ofbiz/tools/wiki-files/birt/Report master creation.md.html Fri Nov 3
12:39:14 2017
@@ -0,0 +1,140 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta name="generator" content="pandoc" />
+ <title></title>
+ <style type="text/css">code{white-space: pre;}</style>
+ <style type="text/css">
+div.sourceCode { overflow-x: auto; }
+table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
+ margin: 0; padding: 0; vertical-align: baseline; border: none; }
+table.sourceCode { width: 100%; line-height: 100%; }
+td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px;
color: #aaaaaa; border-right: 1px solid #aaaaaa; }
+td.sourceCode { padding-left: 5px; }
+code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
+code > span.dt { color: #902000; } /* DataType */
+code > span.dv { color: #40a070; } /* DecVal */
+code > span.bn { color: #40a070; } /* BaseN */
+code > span.fl { color: #40a070; } /* Float */
+code > span.ch { color: #4070a0; } /* Char */
+code > span.st { color: #4070a0; } /* String */
+code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
+code > span.ot { color: #007020; } /* Other */
+code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
+code > span.fu { color: #06287e; } /* Function */
+code > span.er { color: #ff0000; font-weight: bold; } /* Error */
+code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /*
Warning */
+code > span.cn { color: #880000; } /* Constant */
+code > span.sc { color: #4070a0; } /* SpecialChar */
+code > span.vs { color: #4070a0; } /* VerbatimString */
+code > span.ss { color: #bb6688; } /* SpecialString */
+code > span.im { } /* Import */
+code > span.va { color: #19177c; } /* Variable */
+code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
+code > span.op { color: #666666; } /* Operator */
+code > span.bu { } /* BuiltIn */
+code > span.ex { } /* Extension */
+code > span.pp { color: #bc7a00; } /* Preprocessor */
+code > span.at { color: #7d9029; } /* Attribute */
+code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
+code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /*
Annotation */
+code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /*
CommentVar */
+code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /*
Information */
+ </style>
+</head>
+<body>
+<h1 id="report-master-creation">Report master creation</h1>
+<h2 id="introduction">Introduction</h2>
+<p>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.</p>
+<h2 id="pre-requisite">Pre-requisite</h2>
+<ul>
+<li>OFBiz</li>
+<li>Birt plugin</li>
+</ul>
+<h2 id="report-master-based-on-an-entityview">Report Master based on an
entity/view</h2>
+<ol style="list-style-type: decimal">
+<li>Create or choice a database entity or view</li>
+<li>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.</li>
+</ol>
+<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode
xml"> <span class="kw"><form</span><span class="ot"> name=</span><span
class="st">"CTNT_MASTER_EXAMPLE"</span><span class="ot">
type=</span><span class="st">"single"</span><span class="ot">
extends=</span><span
class="st">"AbstractFlexibleReportSearchForm"</span><span
class="kw">></span>
+ <span class="kw"><auto-fields-entity</span><span class="ot">
entity-name=</span><span class="st">"Example"</span><span class="ot">
default-field-type=</span><span class="st">"find"</span><span
class="kw">/></span>
+ <span class="kw"></form></span></code></pre></div>
+<ol start="3" style="list-style-type: decimal">
+<li>Add the informations about this Master in the database using the file
plugins/birt/data/BirtMasterData.xml</li>
+</ol>
+<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode
xml"> <span class="kw"><DataResource</span><span class="ot">
dataResourceId=</span><span
class="st">"DR_MASTER_EXAMPLE"</span><span class="ot">
dataResourceTypeId=</span><span
class="st">"ELECTRONIC_TEXT"</span><span class="ot">
dataTemplateTypeId=</span><span class="st">"FORM_COMBINED"</span>
<span class="kw">/></span>
+ <span class="kw"><ElectronicText</span><span class="ot">
dataResourceId=</span><span
class="st">"DR_MASTER_EXAMPLE"</span><span class="kw">></span>
+ <span class="kw"><textData></span><span
class="bn"><![CDATA[</span><!--default domain form-->
+ <form name="${masterContentId}_${contentId}"
type="single" extends="${masterContentId}" extends-
resource="component://birt/widget/birt/BirtMasterForms.xml">
+ </form><span class="bn">]]></span>
+ <span class="kw"></textData></span>
+ <span class="kw"></ElectronicText></span>
+ <span class="kw"><Content</span><span class="ot">
contentId=</span><span class="st">"CTNT_MASTER_EXAMPLE"</span><span
class="ot"> contentTypeId=</span><span
class="st">"REPORT_MASTER"</span><span class="ot">
dataResourceId=</span><span
class="st">"DR_MASTER_EXAMPLE"</span><span class="ot">
statusId=</span><span class="st">"CTNT_PUBLISHED"</span><span
class="ot"> contentName=</span><span class="st">"Example"</span><span
class="ot"> description=</span><span class="st">"Master Content for
Example"</span> <span class="kw">/></span>
+ <span class="co"><!-- Data retrieval will be done using perform find on
entity Example--></span>
+ <span class="kw"><ContentAttribute</span><span class="ot">
contentId=</span><span class="st">"CTNT_MASTER_EXAMPLE"</span><span
class="ot"> attrName=</span><span class="st">"Entity"</span><span
class="ot"> attrValue=</span><span class="st">"Example"</span><span
class="kw">/></span></code></pre></div>
+<p>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.</p>
+<ol start="4" style="list-style-type: decimal">
+<li>Add in the file content/config/contentEntityLabels.xml the Property that
will allow translation for your report master description.</li>
+</ol>
+<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode
xml"> <span class="kw"><property</span><span class="ot"> key=</span><span
class="st">"Content.description.CTNT_MASTER_EXAMPLE"</span><span
class="kw">></span>
+ <span class="kw"><value</span><span class="ot">
xml:lang=</span><span class="st">"en"</span><span
class="kw">></span>Example<span class="kw"></value></span>
+ <span class="kw"><value</span><span class="ot">
xml:lang=</span><span class="st">"fr"</span><span
class="kw">></span>Exemple<span class="kw"></value></span>
+ <span class="kw"></property></span></code></pre></div>
+<p>Your Report Master is created ! You can now create reports using it.</p>
+<h2 id="report-master-based-on-a-service">Report Master based on a service</h2>
+<p>Create in
plugins/birt/src/org/ofbiz/birt/birt/BirtMasterReportServices.java 2 dedicated
services (see examples there)</p>
+<ol style="list-style-type: decimal">
+<li>The first one, which name will return 4 items:</li>
+</ol>
+<ul>
+<li>an object of type Map<String, String> called dataMap.
<strong>Keys</strong>: data field names. <strong>Values</strong>: data types
(OFBiz types).</li>
+<li>an object of type Map<String, String> called fieldDisplayLabels.
<strong>Keys</strong>: data field names. <strong>Values</strong>: the names
displayed to the user. This output is optional, should it be missing, the keys
will be displayed.</li>
+<li>an object of type Map<String, String> called filterMap.
<strong>Keys</strong>: data filtering field names (exact names used for the
form fields). <strong>Values</strong>: data type (OFBiz type). This output is
optional, if missing, filters can not be displayed on the report.</li>
+<li>an object of type Map<String, String> called filterDisplayLabels.
<strong>Keys</strong>: data filtering field names (exact names used for the
form fields). <strong>Values</strong>: names to be displayed to the user. This
output is optional, should it be missing, the keys will be displayed.</li>
+</ul>
+<ol start="2" style="list-style-type: decimal">
+<li>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:</li>
+</ol>
+<div class="sourceCode"><pre class="sourceCode java"><code class="sourceCode
java"> Map<String, Object> parameters = (Map<String, Object>)
reportContext.<span class="fu">getParameterValue</span>(<span
class="st">"parameters"</span>);</code></pre></div>
+<p>This Map will give access fields of the filtering form. This service will
return a list called list of type List<GenericValue>, containing the data. A
Map<String, Object> would also do.</p>
+<ol start="3" style="list-style-type: decimal">
+<li>create the parent form in the file
plugins/birt/widget/birt/BirtMasterForms.xml. Field names created here must be
then names used on the Map parameters of the previous service, and also
corresponding to the map filterMap.</li>
+</ol>
+<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode
xml"> <span class="kw"><form</span><span class="ot"> name=</span><span
class="st">"CTNT_MASTER_TURNOVER"</span><span class="ot">
type=</span><span class="st">"single"</span><span class="ot">
extends=</span><span
class="st">"AbstractFlexibleReportSearchForm"</span><span
class="kw">></span>
+ <span class="kw"><field</span><span class="ot"> name=</span><span
class="st">"fromDate"</span><span
class="kw">><date-time</span><span class="ot"> type=</span><span
class="st">"date"</span><span class="kw">/></field></span>
+ <span class="kw"><field</span><span class="ot"> name=</span><span
class="st">"thruDate"</span><span
class="kw">><date-time</span><span class="ot"> type=</span><span
class="st">"date"</span><span class="kw">/></field></span>
+ <span class="kw"><field</span><span class="ot"> name=</span><span
class="st">"productCategoryId"</span><span
class="kw">><lookup</span><span class="ot"> target-form-name=</span><span
class="st">"LookupProductCategory"</span><span
class="kw">/></field></span>
+ <span class="kw"><field</span><span class="ot"> name=</span><span
class="st">"productStoreId"</span><span
class="kw">><lookup</span><span class="ot"> target-form-name=</span><span
class="st">"LookupProductStore"</span><span
class="kw">/></field></span>
+ <span class="kw"></form></span></code></pre></div>
+<ol start="4" style="list-style-type: decimal">
+<li>Create the master in database following.</li>
+</ol>
+<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode
xml"> <span class="kw"><CustomMethod</span><span class="ot">
customMethodId=</span><span class="st">"CM_FB_TURNOVER"</span><span
class="ot"> customMethodTypeId=</span><span
class="st">"FLEXIBLE_BIRT"</span><span class="ot">
customMethodName=</span><span
class="st">"flexibleReportTurnOver"</span><span class="ot">
description=</span><span class="st">"service to resolve invoice for
turnover report domain"</span><span class="kw">/></span>
+ <span class="kw"><DataResource</span><span class="ot">
dataResourceId=</span><span
class="st">"DR_MASTER_TURNOVER"</span><span class="ot">
dataResourceTypeId=</span><span
class="st">"ELECTRONIC_TEXT"</span><span class="ot">
dataTemplateTypeId=</span><span class="st">"FORM_COMBINED"</span>
<span class="kw">/></span>
+ <span class="kw"><ElectronicText</span><span class="ot">
dataResourceId=</span><span
class="st">"DR_MASTER_TURNOVER"</span><span class="kw">></span>
+ <span class="kw"><textData></span><span
class="bn"><![CDATA[</span><!--default domain form-->
+ <form name="${masterContentId}_${contentId}"
type="single" extends="${masterContentId}"
extends-resource="component://birt/widget/birt/BirtMasterForms.xml">
+ </form><span class="bn">]]></span>
+ <span class="kw"></textData></span>
+ <span class="kw"></ElectronicText></span>
+ <span class="kw"><Content</span><span class="ot">
contentId=</span><span class="st">"CTNT_MASTER_TURNOVER"</span><span
class="ot"> customMethodId=</span><span
class="st">"CM_FB_TURNOVER"</span><span class="ot">
contentTypeId=</span><span class="st">"REPORT_MASTER"</span><span
class="ot"> dataResourceId=</span><span
class="st">"DR_MASTER_TURNOVER"</span><span class="ot">
statusId=</span><span class="st">"CTNT_PUBLISHED"</span><span
class="ot"> contentName=</span><span
class="st">"Turnover"</span><span class="ot">
description=</span><span class="st">"Master Content for TURNOVER
domain"</span> <span class="kw">/></span>
+ <span class="co"><!-- Data retrieval will be done using two service
calls. First the contentAttribute Service gives the service that will define
which data and label will be retrieved,</span>
+<span class="co"> and which filter and label are supported by the report
design (default value will call the second service with
"prepareField" suffix).</span>
+<span class="co"> Second, the custom method gives the service to retrieve
all data in the report design.</span>
+<span class="co"> Here : flexibleReportTurnOverPrepareFields
(customMethodName + "prepareFields") then
flexibleReportTurnOver--></span>
+ <span class="kw"><ContentAttribute</span><span class="ot">
contentId=</span><span class="st">"CTNT_MASTER_TURNOVER"</span><span
class="ot"> attrName=</span><span class="st">"Service"</span><span
class="ot"> attrValue=</span><span class="st">"default"</span><span
class="kw">/></span></code></pre></div>
+<p>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.</p>
+<ol start="5" style="list-style-type: decimal">
+<li>Import these data in the base using Webtools XML import (or the longer
"gradlew 'ofbiz -l readers=seed,ext' command).</li>
+<li>Add in the file content/config/contentEntityLabels.xml the Property which
will translate your report Master description.</li>
+</ol>
+<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode
xml"> <span class="kw"><property</span><span class="ot"> key=</span><span
class="st">"Content.description.CTNT_MASTER_TURNOVER"</span><span
class="kw">></span>
+ <span class="kw"><value</span><span class="ot">
xml:lang=</span><span class="st">"en"</span><span
class="kw">></span>Turnover (product)<span class="kw"></value></span>
+ <span class="kw"><value</span><span class="ot">
xml:lang=</span><span class="st">"fr"</span><span
class="kw">></span>Rotation (des stocks)<span
class="kw"></value></span>
+ <span class="kw"></property></span></code></pre></div>
+<h2 id="entities-diagram">Entities diagram</h2>
+<p>The following diagram shows the Entities linked with Content to store
report_master/report. <img
src="https://cwiki.apache.org/confluence/download/attachments/68720496/Report_Master.png?api=v2";
alt="Report_Master" /></p>
+</body>
+</html>
Propchange: ofbiz/tools/wiki-files/birt/Report master creation.md.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/tools/wiki-files/birt/Report master creation.md.html
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/tools/wiki-files/birt/Report master creation.md.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html
URL:
http://svn.apache.org/viewvc/ofbiz/tools/wiki-files/birt/Using%20the%20Birt%20Report%20Designer.md.html?rev=1814171&view=auto
==============================================================================
--- ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html (added)
+++ ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html Fri Nov
3 12:39:14 2017
@@ -0,0 +1,76 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta name="generator" content="pandoc" />
+ <title></title>
+ <style type="text/css">code{white-space: pre;}</style>
+</head>
+<body>
+<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>
+<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>
+<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 should find the .rptdesign files you downloaded.</p>
+<div class="figure">
+<img
src="https://cwiki.apache.org/confluence/download/attachments/68720496/Report%20Builder.png?api=v2";
alt="Report Builder" />
+<p class="caption">Report Builder</p>
+</div>
+<h3 id="data-explorer">Data Explorer</h3>
+<p>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>
+<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>
+<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>
+<li>Layout, which will allow most of the design.</li>
+<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>
+<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>
+<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>
+<li>Right-click on the table -> Edit Data Binding, select all fields</li>
+<li>In the data set field, change "None" in "Data Set",
validate</li>
+<li>Right-click the table -> Insert Group. Configure your group, eg: <img
src="https://cwiki.apache.org/confluence/download/attachments/68720496/Group.png?api=v2";
alt="group" /></li>
+<li>Your table then has five lines:</li>
+</ol>
+<ul>
+<li>A global title line</li>
+<li>A title line of the group</li>
+<li>A group detail line</li>
+<li>A footer of the group</li>
+<li>A global footer line</li>
+</ul>
+<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>
+<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>
+</blockquote>
+<h2 id="layout-management">Layout Management</h2>
+<h3 id="general-settings">General settings</h3>
+<p>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.</p>
+<h3 id="styles">Styles</h3>
+<p>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, ...).</p>
+</body>
+</html>
Propchange: ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: ofbiz/tools/wiki-files/demo/README.md.html
URL:
http://svn.apache.org/viewvc/ofbiz/tools/wiki-files/demo/README.md.html?rev=1814171&view=auto
==============================================================================
--- ofbiz/tools/wiki-files/demo/README.md.html (added)
+++ ofbiz/tools/wiki-files/demo/README.md.html Fri Nov 3 12:39:14 2017
@@ -0,0 +1,48 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta name="generator" content="pandoc" />
+ <title></title>
+ <style type="text/css">code{white-space: pre;}</style>
+</head>
+<body>
+<p>Three instances of OFBiz run on the OFBiz demo VM2 at
https://ofbiz-vm2.apache.org.</p>
+<ul>
+<li>trunk: the trunk version</li>
+<li>stable: the last stable version (currently 16.11)</li>
+<li>old: the previous stable version (currently 13.07)</li>
+</ul>
+<p>This is the second instance of VM we use hence the 2 in its domain name.
The root of https://ofbiz-vm2.apache.org is the so called bigfiles directory
which is actually at /home/ofbizDemo/big-files</p>
+<p>We own 3 Apache sub domains</p>
+<ul>
+<li>https://demo-trunk.ofbiz.apache.org</li>
+<li>https://demo-stable.ofbiz.apache.org</li>
+<li>https://demo-old.ofbiz.apache.org</li>
+</ul>
+<p>All demos use a Let's Encrypt certificate. There is currently a bug which
prevents Let's Encrypt certificate to renew every 3 months. So we need to do it
by hand and you need to have a root access for that. This is how: <a
href="http://markmail.org/message/7c3rxrqkn4kkm6dm";
class="uri">http://markmail.org/message/7c3rxrqkn4kkm6dm</a></p>
+<p>The Puppet configuration is at
https://github.com/apache/infrastructure-puppet/blob/deployment/data/nodes/ofbiz-vm2.apache.org.yaml</p>
+<blockquote>
+<p><em>Note</em>: <strong>Only run the ofbiz demos using the 'ofbizDemo' user,
never run as root.</strong></p>
+</blockquote>
+<pre><code>To do this sudo to the ofbizDemo user:
+
+sudo -s -u ofbizDemo -H
+
+sudo uses OTP (One Time Password), so you not only need to be registered as a
sudoer (ask Infra) but also to use a tool like Donkey on Ubuntu (jleroux: I use
that) to generate the OTP
+Then you can start/stop as required.
+
+To check if the demos are being run as the ofbizDemo user:
+
+ps aux | grep ofbizDemo
+
+The first column on the left tell you the username the demo is
+being run as - it should say ofbizDemo (UID) or 9997 (GID) !
+
+Type 'exit' to exit the ofbizDemo user and return to your normal
user.</code></pre>
+<p>Also note that the demos are usually updated and started/stopped
automatically using the check-svn-update.sh script in this directory, it is run
by an ofbiz cron job every 24 hours at 3 AM. You should therefore only need to
start/stop manually if there is a problem.</p>
+<p>If you want to restart only a single instance you can respectively use</p>
+<p>trunk-manual-nicely.sh stable-manual-nicely.sh old-manual-nicely.sh</p>
+</body>
+</html>
Propchange: ofbiz/tools/wiki-files/demo/README.md.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/tools/wiki-files/demo/README.md.html
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/tools/wiki-files/demo/README.md.html
------------------------------------------------------------------------------
svn:mime-type = text/html
![https://cwiki.apache.org/confluence/download/attachments/68720496/Birt%20Menus.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Birt%20Menus.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Example%20Report.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Example%20Report.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Edit%20Report%20screen.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Edit%20Report%20screen.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Report_Master.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Report_Master.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Report%20Builder.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Report%20Builder.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Data%20Explorer.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Data%20Explorer.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Palette.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Palette.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Group.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Group.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Design%20with%20break.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Design%20with%20break.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Aggregation%20builder.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Aggregation%20builder.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Expression%20builder.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Expression%20builder.png?api=v2"){kind=link}
![https://cwiki.apache.org/confluence/download/attachments/68720496/Design%20with%20break%20complete.png?api=v2"](https://cwiki.apache.org/confluence/download/attachments/68720496/Design%20with%20break%20complete.png?api=v2"){kind=link}