OFBiz › OFBiz - Commits

svn commit: r1826200 [1/3] - in /ofbiz: ofbiz-plugins/trunk/birt/documents/ tools/wiki-files/ tools/wiki-files/BuildBot/ tools/wiki-files/birt/ tools/wiki-files/data-model/ tools/wiki-files/demos/ tools/wiki-files/themes/

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

1 message

jleroux@apache.org

svn commit: r1826200 [1/3] - in /ofbiz: ofbiz-plugins/trunk/birt/documents/ tools/wiki-files/ tools/wiki-files/BuildBot/ tools/wiki-files/birt/ tools/wiki-files/data-model/ tools/wiki-files/demos/ tools/wiki-files/themes/

Author: jleroux
Date: Thu Mar 8 10:42:54 2018
New Revision: 1826200

URL: http://svn.apache.org/viewvc?rev=1826200&view=rev
Log:
I locally updated Pandoc and it now generates HTML5 code
So when using the -s argument it now generates this warning

[WARNING] This document format requires a nonempty <title> element
Please specify either 'title' or 'pagetitle' in the metadata.
Falling back to 'README'

This means that since HTML5 requires a title Pandoc generates it using the file
name

There are 2 options:

* add the -quiet option to hide the warning (lazy/easy)
* add the 'title' or 'pagetitle' in the metadata a bit heavy, default is OK with
me

I decided to not change anything since this will anyway certainly changed with
our new way of documenting

So here are new generated HTML5 pages, also fixes a typo in Creating reports.md

Modified:
ofbiz/ofbiz-plugins/trunk/birt/documents/Creating reports.md
ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html
ofbiz/tools/wiki-files/README.md.html
ofbiz/tools/wiki-files/birt/Creating reports.md.html
ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html
ofbiz/tools/wiki-files/birt/Report master creation.md.html
ofbiz/tools/wiki-files/birt/Using the Birt Report Designer.md.html
ofbiz/tools/wiki-files/data-model/DATAMODEL_CHANGES.md.html
ofbiz/tools/wiki-files/demos/README.md.html
ofbiz/tools/wiki-files/themes/README.md.html

Modified: ofbiz/ofbiz-plugins/trunk/birt/documents/Creating reports.md
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/documents/Creating%20reports.md?rev=1826200&r1=1826199&r2=1826200&view=diff
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/documents/Creating reports.md (original)
+++ ofbiz/ofbiz-plugins/trunk/birt/documents/Creating reports.md Thu Mar 8 10:42:54 2018
@@ -27,7 +27,7 @@ Once the form is validated, OFBiz will s
## 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.

-## The .rptdesign report file: donwload, 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 the ["Using the Birt Report Designer.md.html" file](https://svn.apache.org/repos/asf/ofbiz/ofbiz-plugins/trunk/birt/documents/Using%20the%20Birt%20Report%20Designer.md.html). 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.

Modified: ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html
URL: http://svn.apache.org/viewvc/ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html?rev=1826200&r1=1826199&r2=1826200&view=diff
==============================================================================
--- ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html (original)
+++ ofbiz/tools/wiki-files/BuildBot/BuildBot.md.html Thu Mar 8 10:42:54 2018
@@ -1,11 +1,19 @@
-<!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">
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta charset="utf-8" />
<meta name="generator" content="pandoc" />
- <title></title>
- <style type="text/css">code{white-space: pre;}</style>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+ <title>BuildBot</title>
+ <style type="text/css">
+ code{white-space: pre-wrap;}
+ span.smallcaps{font-variant: small-caps;}
+ span.underline{text-decoration: underline;}
+ div.column{display: inline-block; vertical-align: top; width: 50%;}
+ </style>
+ 
</head>
<body>

</head>
<body>

</head>
<body>
<h1 id="report-creation---adminsuper-user">Report creation - Admin/Super-User</h1>
@@ -18,30 +26,30 @@
<li>The BIRT Report Designer</li>
</ul>
<h2 id="report-creation">Report creation</h2>
-<ol style="list-style-type: decimal">
+<ol type="1">
<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>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 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>
+<li>The box âGenerate filters in designâ will add in the design the visualisation of the filters filled in the filtering form.</li>
</ul>
-Finally, if you don't find what you want, you will need to create a new Report Master...
-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" />
+Finally, if you donât find what you want, you will need to create a new Report Masterâ¦
+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" />
<h2 id="report-information">Report information</h2>
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.
-<h2 id="the-.rptdesign-report-file-donwload-edit-upload-and-publish-it">The .rptdesign report file: donwload, edit, upload and publish it</h2>
-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.
-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.
+<h2 id="the-.rptdesign-report-file-download-edit-upload-and-publish-it">The .rptdesign report file: download, edit, upload and publish it</h2>
+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.
+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.
<h2 id="filters-overriding">Filters Overriding</h2>
-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.
+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.
<h2 id="manage-reports">Manage reports</h2>
-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.
<h2 id="use-a-report">Use a report</h2>
-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
</body>
</html>

Modified: 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=1826200&r1=1826199&r2=1826200&view=diff
==============================================================================
--- ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html (original)
+++ ofbiz/tools/wiki-files/birt/How to use flexible reports.md.html Thu Mar 8 10:42:54 2018
@@ -1,11 +1,19 @@
-<!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">
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta charset="utf-8" />
<meta name="generator" content="pandoc" />
- <title></title>
- <style type="text/css">code{white-space: pre;}</style>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+ <title>How to use flexible reports</title>
+ <style type="text/css">
+ code{white-space: pre-wrap;}
+ span.smallcaps{font-variant: small-caps;}
+ span.underline{text-decoration: underline;}
+ div.column{display: inline-block; vertical-align: top; width: 50%;}
+ </style>
+ 
</head>
<body>
<h1 id="using-a-flexible-report---user">Using a flexible report - User</h1>
@@ -18,10 +26,10 @@
<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">
+<ol type="1">
<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>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>

Modified: 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=1826200&r1=1826199&r2=1826200&view=diff
==============================================================================
--- ofbiz/tools/wiki-files/birt/Report master creation.md.html (original)
+++ ofbiz/tools/wiki-files/birt/Report master creation.md.html Thu Mar 8 10:42:54 2018
@@ -1,48 +1,84 @@
-<!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">
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta http-equiv="Content-Style-Type" content="text/css" />
+ <meta charset="utf-8" />
<meta name="generator" content="pandoc" />
- <title></title>
- <style type="text/css">code{white-space: pre;}</style>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+ <title>Report master creation</title>
<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 */
+ code{white-space: pre-wrap;}
+ span.smallcaps{font-variant: small-caps;}
+ span.underline{text-decoration: underline;}
+ div.column{display: inline-block; vertical-align: top; width: 50%;}
</style>
+ <style type="text/css">
+a.sourceLine { display: inline-block; line-height: 1.25; }
+a.sourceLine { pointer-events: none; color: inherit; text-decoration: inherit; }
+a.sourceLine:empty { height: 1.2em; position: absolute; }
+.sourceCode { overflow: visible; }
+code.sourceCode { white-space: pre; position: relative; }
+div.sourceCode { margin: 1em 0; }
+pre.sourceCode { margin: 0; }
+@media screen {
+div.sourceCode { overflow: auto; }
+}
+@media print {
+code.sourceCode { white-space: pre-wrap; }
+a.sourceLine { text-indent: -1em; padding-left: 1em; }
+}
+pre.numberSource a.sourceLine
+ { position: relative; }
+pre.numberSource a.sourceLine:empty
+ { position: absolute; }
+pre.numberSource a.sourceLine::before
+ { content: attr(data-line-number);
+ position: absolute; left: -5em; text-align: right; vertical-align: baseline;
+ border: none; pointer-events: all;
+ -webkit-touch-callout: none; -webkit-user-select: none;
+ -khtml-user-select: none; -moz-user-select: none;
+ -ms-user-select: none; user-select: none;
+ padding: 0 4px; width: 4em;
+ color: #aaaaaa;
+ }
+pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
+div.sourceCode
+ { }
+@media screen {
+a.sourceLine::before { text-decoration: underline; }
+}
+code span.al { color: #ff0000; font-weight: bold; } /* Alert */
+code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
+code span.at { color: #7d9029; } /* Attribute */
+code span.bn { color: #40a070; } /* BaseN */
+code span.bu { } /* BuiltIn */
+code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
+code span.ch { color: #4070a0; } /* Char */
+code span.cn { color: #880000; } /* Constant */
+code span.co { color: #60a0b0; font-style: italic; } /* Comment */
+code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
+code span.do { color: #ba2121; font-style: italic; } /* Documentation */
+code span.dt { color: #902000; } /* DataType */
+code span.dv { color: #40a070; } /* DecVal */
+code span.er { color: #ff0000; font-weight: bold; } /* Error */
+code span.ex { } /* Extension */
+code span.fl { color: #40a070; } /* Float */
+code span.fu { color: #06287e; } /* Function */
+code span.im { } /* Import */
+code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
+code span.kw { color: #007020; font-weight: bold; } /* Keyword */
+code span.op { color: #666666; } /* Operator */
+code span.ot { color: #007020; } /* Other */
+code span.pp { color: #bc7a00; } /* Preprocessor */
+code span.sc { color: #4070a0; } /* SpecialChar */
+code span.ss { color: #bb6688; } /* SpecialString */
+code span.st { color: #4070a0; } /* String */
+code span.va { color: #19177c; } /* Variable */
+code span.vs { color: #4070a0; } /* VerbatimString */
+code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
+ </style>
+ 
</head>
<body>
<h1 id="report-master-creation">Report master creation</h1>
@@ -54,86 +90,86 @@ code > span.in { color: #60a0b0; font-we
<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">
+<ol type="1">
<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"> <form name="CTNT_MASTER_EXAMPLE" type="single" extends="AbstractFlexibleReportSearchForm">
- <auto-fields-entity entity-name="Example" default-field-type="find"/>
- </form></code></pre></div>
-<ol start="3" style="list-style-type: decimal">
+<div class="sourceCode" id="cb1"><pre class="sourceCode xml"><code class="sourceCode xml"><a class="sourceLine" id="cb1-1" data-line-number="1"> <form name="CTNT_MASTER_EXAMPLE" type="single" extends="AbstractFlexibleReportSearchForm"> </a>
+<a class="sourceLine" id="cb1-2" data-line-number="2"> <auto-fields-entity entity-name="Example" default-field-type="find"/></a>
+<a class="sourceLine" id="cb1-3" data-line-number="3"> </form></a></code></pre></div>
+<ol start="3" type="1">
<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"> <DataResource dataResourceId="DR_MASTER_EXAMPLE" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="FORM_COMBINED" />
- <ElectronicText dataResourceId="DR_MASTER_EXAMPLE">
- <textData><![CDATA[
- <form name="${masterContentId}_${contentId}" type="single" extends="${masterContentId}" extends- resource="component://birt/widget/birt/BirtMasterForms.xml">
- </form>]]>
- </textData>
- </ElectronicText>
- <Content contentId="CTNT_MASTER_EXAMPLE" contentTypeId="REPORT_MASTER" dataResourceId="DR_MASTER_EXAMPLE" statusId="CTNT_PUBLISHED" contentName="Example" description="Master Content for Example" />
- 
- <ContentAttribute contentId="CTNT_MASTER_EXAMPLE" attrName="Entity" attrValue="Example"/></code></pre></div>
+<div class="sourceCode" id="cb2"><pre class="sourceCode xml"><code class="sourceCode xml"><a class="sourceLine" id="cb2-1" data-line-number="1"> <DataResource dataResourceId="DR_MASTER_EXAMPLE" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="FORM_COMBINED" /></a>
+<a class="sourceLine" id="cb2-2" data-line-number="2"> <ElectronicText dataResourceId="DR_MASTER_EXAMPLE"></a>
+<a class="sourceLine" id="cb2-3" data-line-number="3"> <textData><![CDATA[</a>
+<a class="sourceLine" id="cb2-4" data-line-number="4"> <form name="${masterContentId}_${contentId}" type="single" extends="${masterContentId}" extends- resource="component://birt/widget/birt/BirtMasterForms.xml"></a>
+<a class="sourceLine" id="cb2-5" data-line-number="5"> </form>]]></a>
+<a class="sourceLine" id="cb2-6" data-line-number="6"> </textData></a>
+<a class="sourceLine" id="cb2-7" data-line-number="7"> </ElectronicText></a>
+<a class="sourceLine" id="cb2-8" data-line-number="8"> <Content contentId="CTNT_MASTER_EXAMPLE" contentTypeId="REPORT_MASTER" dataResourceId="DR_MASTER_EXAMPLE" statusId="CTNT_PUBLISHED" contentName="Example" description="Master Content for Example" /></a>
+<a class="sourceLine" id="cb2-9" data-line-number="9"> </a>
+<a class="sourceLine" id="cb2-10" data-line-number="10"> <ContentAttribute contentId="CTNT_MASTER_EXAMPLE" attrName="Entity" attrValue="Example"/></a></code></pre></div>
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.
-<ol start="4" style="list-style-type: decimal">
+<ol start="4" type="1">
<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"> <property key="Content.description.CTNT_MASTER_EXAMPLE">
- <value xml:lang="en">Example</value>
- <value xml:lang="fr">Exemple</value>
- </property></code></pre></div>
+<div class="sourceCode" id="cb3"><pre class="sourceCode xml"><code class="sourceCode xml"><a class="sourceLine" id="cb3-1" data-line-number="1"> <property key="Content.description.CTNT_MASTER_EXAMPLE"></a>
+<a class="sourceLine" id="cb3-2" data-line-number="2"> <value xml:lang="en">Example</value></a>
+<a class="sourceLine" id="cb3-3" data-line-number="3"> <value xml:lang="fr">Exemple</value></a>
+<a class="sourceLine" id="cb3-4" data-line-number="4"> </property></a></code></pre></div>
Your Report Master is created ! You can now create reports using it.
<h2 id="report-master-based-on-a-service">Report Master based on a service</h2>
Create in plugins/birt/src/org/ofbiz/birt/birt/BirtMasterReportServices.java 2 dedicated services (see examples there)
-<ol style="list-style-type: decimal">
+<ol type="1">
<li>The first one, which name will return 4 items:</li>
</ol>
<ul>
-<li>an object of type Map<String, String> called dataMap. Keys: data field names. Values: data types (OFBiz types).</li>
-<li>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.</li>
-<li>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.</li>
-<li>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.</li>
+<li>an object of type Map<String, String> called dataMap. Keys: data field names. Values: data types (OFBiz types).</li>
+<li>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.</li>
+<li>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.</li>
+<li>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.</li>
</ul>
-<ol start="2" style="list-style-type: decimal">
+<ol start="2" type="1">
<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.getParameterValue("parameters");</code></pre></div>
-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.
-<ol start="3" style="list-style-type: decimal">
+<div class="sourceCode" id="cb4"><pre class="sourceCode java"><code class="sourceCode java"><a class="sourceLine" id="cb4-1" data-line-number="1"> Map<String, Object> parameters = (Map<String, Object>) reportContext.getParameterValue("parameters");</a></code></pre></div>
+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.
+<ol start="3" type="1">
<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"> <form name="CTNT_MASTER_TURNOVER" type="single" extends="AbstractFlexibleReportSearchForm">
- <field name="fromDate"><date-time type="date"/></field>
- <field name="thruDate"><date-time type="date"/></field>
- <field name="productCategoryId"><lookup target-form-name="LookupProductCategory"/></field>
- <field name="productStoreId"><lookup target-form-name="LookupProductStore"/></field>
- </form></code></pre></div>
-<ol start="4" style="list-style-type: decimal">
+<div class="sourceCode" id="cb5"><pre class="sourceCode xml"><code class="sourceCode xml"><a class="sourceLine" id="cb5-1" data-line-number="1"> <form name="CTNT_MASTER_TURNOVER" type="single" extends="AbstractFlexibleReportSearchForm"></a>
+<a class="sourceLine" id="cb5-2" data-line-number="2"> <field name="fromDate"><date-time type="date"/></field></a>
+<a class="sourceLine" id="cb5-3" data-line-number="3"> <field name="thruDate"><date-time type="date"/></field></a>
+<a class="sourceLine" id="cb5-4" data-line-number="4"> <field name="productCategoryId"><lookup target-form-name="LookupProductCategory"/></field></a>
+<a class="sourceLine" id="cb5-5" data-line-number="5"> <field name="productStoreId"><lookup target-form-name="LookupProductStore"/></field></a>
+<a class="sourceLine" id="cb5-6" data-line-number="6"> </form></a></code></pre></div>
+<ol start="4" type="1">
<li>Create the master in database following.</li>
</ol>
-<div class="sourceCode"><pre class="sourceCode xml"><code class="sourceCode xml"> <CustomMethod customMethodId="CM_FB_TURNOVER" customMethodTypeId="FLEXIBLE_BIRT" customMethodName="flexibleReportTurnOver" description="service to resolve invoice for turnover report domain"/>
- <DataResource dataResourceId="DR_MASTER_TURNOVER" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="FORM_COMBINED" />
- <ElectronicText dataResourceId="DR_MASTER_TURNOVER">
- <textData><![CDATA[
- <form name="${masterContentId}_${contentId}" type="single" extends="${masterContentId}" extends-resource="component://birt/widget/birt/BirtMasterForms.xml">
- </form>]]>
- </textData>
- </ElectronicText>
- <Content contentId="CTNT_MASTER_TURNOVER" customMethodId="CM_FB_TURNOVER" contentTypeId="REPORT_MASTER" dataResourceId="DR_MASTER_TURNOVER" statusId="CTNT_PUBLISHED" contentName="Turnover" description="Master Content for TURNOVER domain" />
- 
- <ContentAttribute contentId="CTNT_MASTER_TURNOVER" attrName="Service" attrValue="default"/></code></pre></div>
+<div class="sourceCode" id="cb6"><pre class="sourceCode xml"><code class="sourceCode xml"><a class="sourceLine" id="cb6-1" data-line-number="1"> <CustomMethod customMethodId="CM_FB_TURNOVER" customMethodTypeId="FLEXIBLE_BIRT" customMethodName="flexibleReportTurnOver" description="service to resolve invoice for turnover report domain"/></a>
+<a class="sourceLine" id="cb6-2" data-line-number="2"> <DataResource dataResourceId="DR_MASTER_TURNOVER" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="FORM_COMBINED" /></a>
+<a class="sourceLine" id="cb6-3" data-line-number="3"> <ElectronicText dataResourceId="DR_MASTER_TURNOVER"></a>
+<a class="sourceLine" id="cb6-4" data-line-number="4"> <textData><![CDATA[</a>
+<a class="sourceLine" id="cb6-5" data-line-number="5"> <form name="${masterContentId}_${contentId}" type="single" extends="${masterContentId}" extends-resource="component://birt/widget/birt/BirtMasterForms.xml"></a>
+<a class="sourceLine" id="cb6-6" data-line-number="6"> </form>]]></a>
+<a class="sourceLine" id="cb6-7" data-line-number="7"> </textData></a>
+<a class="sourceLine" id="cb6-8" data-line-number="8"> </ElectronicText></a>
+<a class="sourceLine" id="cb6-9" data-line-number="9"> <Content contentId="CTNT_MASTER_TURNOVER" customMethodId="CM_FB_TURNOVER" contentTypeId="REPORT_MASTER" dataResourceId="DR_MASTER_TURNOVER" statusId="CTNT_PUBLISHED" contentName="Turnover" description="Master Content for TURNOVER domain" /></a>
+<a class="sourceLine" id="cb6-10" data-line-number="10"> </a>
+<a class="sourceLine" id="cb6-14" data-line-number="14"> <ContentAttribute contentId="CTNT_MASTER_TURNOVER" attrName="Service" attrValue="default"/></a></code></pre></div>
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.
-<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>
+<ol start="5" type="1">
+<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"> <property key="Content.description.CTNT_MASTER_TURNOVER">
- <value xml:lang="en">Turnover (product)</value>
- <value xml:lang="fr">Rotation (des stocks)</value>
- </property></code></pre></div>
+<div class="sourceCode" id="cb7"><pre class="sourceCode xml"><code class="sourceCode xml"><a class="sourceLine" id="cb7-1" data-line-number="1"> <property key="Content.description.CTNT_MASTER_TURNOVER"></a>
+<a class="sourceLine" id="cb7-2" data-line-number="2"> <value xml:lang="en">Turnover (product)</value></a>
+<a class="sourceLine" id="cb7-3" data-line-number="3"> <value xml:lang="fr">Rotation (des stocks)</value></a>
+<a class="sourceLine" id="cb7-4" data-line-number="4"> </property></a></code></pre></div>
<h2 id="entities-diagram">Entities diagram</h2>
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" />
</body>