OFBiz › OFBiz - Commits

svn commit: r1788911 - in /ofbiz/ofbiz-plugins/trunk/birt/documents: Report master creation.md Report master creation.md.html

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

1 message

jleroux@apache.org

svn commit: r1788911 - in /ofbiz/ofbiz-plugins/trunk/birt/documents: Report master creation.md Report master creation.md.html

Author: jleroux
Date: Mon Mar 27 11:57:07 2017
New Revision: 1788911

URL: http://svn.apache.org/viewvc?rev=1788911&view=rev
Log:
Documented: Complete Birt Flexible Reports documentation
(OFBIZ-9188)

This is the technical documentation about the Flexible Reports.
It's done with Markdown files with links to Confluence for images

Also the HTML version soon used in the wiki

Added:
ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md (with props)
ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md.html (with props)

Added: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/documents/Report%20master%20creation.md?rev=1788911&view=auto
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md (added)
+++ ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md Mon Mar 27 11:57:07 2017
@@ -0,0 +1,113 @@
+# Report master creation #
+
+## Introduction ##
+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 ##
+- OFBiz
+- Birt plugin
+
+## Report Master based on an entity/view ##
+
+
+1. Create or choice a database entity or view
+2. 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.
+
+```xml
+ <form name="CTNT_MASTER_EXAMPLE" type="single" extends="AbstractFlexibleReportSearchForm">
+ <auto-fields-entity entity-name="Example" default-field-type="find"/>
+ </form>
+```
+
+3. Add the informations about this Master in the database using the file plugins/birt/data/BirtMasterData.xml
+
+```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"/>
+```
+
+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.
+
+4. Add in the file content/config/contentEntityLabels.xml the Property that will allow translation for your report master description.
+
+```xml
+ <property key="Content.description.CTNT_MASTER_EXAMPLE">
+ <value xml:lang="en">Example</value>
+ <value xml:lang="fr">Exemple</value>
+ </property>
+```
+
+Your Report Master is created ! You can now create reports using it.
+
+## Report Master based on a service ##
+Create in plugins/birt/src/org/ofbiz/birt/birt/BirtMasterReportServices.java 2 dedicated services (see examples there)
+
+1. The first one, which name 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.
+2. 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:
+
+```java
+ Map<String, Object> parameters = (Map<String, Object>) reportContext.getParameterValue("parameters");
+```
+
+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.
+
+3. 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.
+
+```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>
+```
+
+4. Create the master in database following.
+
+```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"/>
+```
+
+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.
+
+5. Import these data in the base using Webtools XML import (or the longer "gradlew 'ofbiz -l readers=seed,ext' command).
+6. Add in the file content/config/contentEntityLabels.xml the Property which will translate your report Master description.
+
+```xml
+ <property key="Content.description.CTNT_MASTER_TURNOVER">
+ <value xml:lang="en">Turnover (product)</value>
+ <value xml:lang="fr">Rotation (des stocks)</value>
+ </property>
+```
+
+Entities diagram
+-----------------
+The following diagram shows the Entities linked with Content to store report_master/report.
+![Report_Master](https://cwiki.apache.org/confluence/download/attachments/68720496/Report_Master.png?api=v2)

Propchange: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md
------------------------------------------------------------------------------
svn:eol-style = native

Propchange: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id

Propchange: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md
------------------------------------------------------------------------------
svn:mime-type = text/plain

Added: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md.html
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-plugins/trunk/birt/documents/Report%20master%20creation.md.html?rev=1788911&view=auto
==============================================================================
--- ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md.html (added)
+++ ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md.html Mon Mar 27 11:57:07 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>
+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.
+<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"> <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">
+<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>
+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">
+<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>
+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">
+<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>
+</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.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">
+<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">
+<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>
+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>
+<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>
+<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>
+</html>

Propchange: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md.html
------------------------------------------------------------------------------
svn:eol-style = native

Propchange: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md.html
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id

Propchange: ofbiz/ofbiz-plugins/trunk/birt/documents/Report master creation.md.html
------------------------------------------------------------------------------
svn:mime-type = text/html