Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

improve webtools, birt help....

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/branches/addBirt@826599 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information...
commit 5eb4387f7147e896b0a5f73f70f58a24467769e5 1 parent e3123f3
@hansbak hansbak authored
View
7 applications/content/data/WebtoolsHelpData.xml
@@ -45,5 +45,12 @@
<Content contentId="SELENIUM_HTTPS" contentTypeId="DOCUMENT" contentName="OFBiz Selenium with HTTPS" templateDataResourceId="HELP_TEMPL" dataResourceId="SELENIUM_HTTPS" localeString="en" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
<ContentAssoc contentId="DOCUMENTS" contentIdTo="SELENIUM_HTTPS" contentAssocTypeId="SUB_CONTENT" fromDate="2006-01-12 01:01:01" sequenceNum="" />
+ <!-- BIRT Help -->
+ <DataResource dataResourceId="HELP_BIRT" localeString="en" dataResourceTypeId="OFBIZ_FILE"
+ objectInfo="framework/webtools/data/helpdata/HELP_BIRT.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
+ dataResourceName="BIRT" mimeTypeId="text/xml" isPublic="Y" />
+ <Content contentId="HELP_BIRT" contentTypeId="DOCUMENT" contentName="BIRT" templateDataResourceId="HELP_TEMPL"
+ dataResourceId="HELP_BIRT" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
+ <ContentAssoc contentId="HELP_WEBTOOLS" contentIdTo="HELP_BIRT" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="" mapKey="WEBTOOLS_birt"/>
</entity-engine-xml>
View
32 framework/webtools/data/helpdata/BirtHelpData.xml
@@ -1,32 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<entity-engine-xml>
- <DataResource dataResourceId="HELP_BIRT" localeString="en" dataResourceTypeId="OFBIZ_FILE"
- objectInfo="framework/webtools/data/helpdata/HELP_BIRT.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
- dataResourceName="BIRT Overview" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="HELP_BIRT" contentTypeId="DOCUMENT" contentName="BIRT Overview" templateDataResourceId="HELP_TEMPL"
- dataResourceId="HELP_BIRT" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
- <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_BIRT" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/>
-
- <DataResource dataResourceId="BIRT_reports" localeString="en" dataResourceTypeId="OFBIZ_FILE"
- objectInfo="framework/webtools/data/helpdata/HELP_BIRT_reports.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="BIRT Reports" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="BIRT_reports" contentTypeId="DOCUMENT" contentName="Reports" templateDataResourceId="HELP_TEMPL" dataResourceId="BIRT_reports" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="HELP_BIRT" contentIdTo="BIRT_reports" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/>
-</entity-engine-xml>
View
75 framework/webtools/data/helpdata/HELP_BIRT.xml
@@ -23,27 +23,64 @@ under the License.
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
- <title>BIRT Overview</title>
+ <title>OFBiz BIRT </title>
<para>
- BIRT is an Eclipse-based open source reporting system for web applications,
- especially those based on Java and J2EE. BIRT has two main components: a report designer based on Eclipse,
- and a runtime component that you can add to your app server.
- BIRT also offers a charting engine that lets you add charts to your own application.
+ Welcome to OFBiz Birt. The part installed within OFBiz allows you to run the reports which are prepared using Eclipse with the Birt plugin installed.
+ As a demo we have prepared a product report as an example.
+ Look at the <link xl:href="http://eclipse.org/birt/phoenix/">Eclipse BIRT web site</link> for more information.
</para>
+ <para>
+ This is a short document to help you get started using BIRT to make a report.
+ </para>
+ <section>
+ <title>1. Viewer tab</title>
+ <para>When you click on the Viewer tab. It will show the report in the viewer where the report can be paged.</para>
+ </section>
+ <section>
+ <title>2. Report tab</title>
+ <para>When you click on the Report tab. It will show the complete report in an iframe.</para>
+ </section>
+ <section>
+ <title>3. Mail tab</title>
+ <para>When you click on the Mail tab. It will show a form that can send the report per email.</para>
+ </section>
+ <section>
+ <title>4. View Handler tab</title>
+ <para>When you click on the View Handler tab. It will render the report in a pdf format</para>
+ </section>
+ <section>
+ <title>Examine the Example Report</title>
+ <para>
+ The example report that run in OFBiz is in the file component://webtools/webapp/birt/report/product.rptdesign. When you have started Eclipse Birt, open this document.
+ This report show how a report receives data from OFBiz through Scripted Data Source using the OFBiz delegator.
+ This report has the scripted data source name "OFBiz" and the data set that use the script data source name is called "Product".
+ Open the script editor for Product data set, it uses the delegator object query data from the Product entity.
+ A report that runs on the OFBiz platform can use the delegator object, dispatcher object, security object and classpath of OFBiz environment in the script.</para>
+ </section>
+ <section>
+ <title>Important file for using BIRT's jsp tags</title>
+ <para>
+ If a web applications wants to use the report in a screen, copy birt.tld file to [WEB APP]/WEB-INF/ directory ant assign in in ftl
+ like &lt;#assign birt = JspTaglibs["/WEB-INF/birt.tld"]/&gt;</para>
+ </section>
+ <section>
+ <title>Important tag's attribute in ftl.</title>
+ <para>
+ The BIRT Viewer uses some servlets and resource files such as image, js, css for rendering the report and viewer.
+ When you use the viewer tag or report tag in a ftl file you must add a specific "baseURL" attribute to the birt webapp for these resources like baseURL="/birt".
+ </para>
+ </section>
+ <section>
+ <title>How do I send parameter to report.</title>
+ <para>If a report is to be rendered through a view map, you can send a parameter through attribute of the request object, the attribute's name is "birtParameters" which is a map.</para>
+ <para>If a report is to be rendered through an e-mail, you can send the parameter through the service's parameter name called birtParameters.</para>
+ </section>
<section>
- <title>With BIRT, you can add a rich variety of reports to your application.</title>
- <para>Lists - The simplest reports are lists of data. As the lists get longer,
- you can add grouping to organize related data together (orders grouped by customer,
- products grouped by supplier). If your data is numeric, you can easily add totals, averages and other summaries.</para>
- <para>Charts - Numeric data is much easier to understand when presented as a chart.
- BIRT provides pie charts, line &amp; bar charts and many more.
- BIRT charts can be rendered in SVG and support events to allow user interaction.</para>
- <para>Crosstabs - Crosstabs (also called a cross-tabulation or matrix) shows data in two dimensions: sales per quarter or hits per web page.</para>
- <para>Letters &amp; Documents - Notices, form letters, and other textual documents are easy to create with BIRT.
- Documents can include text, formatting, lists, charts and more.</para>
- <para>Compound Reports - Many reports need to combine the above into a single document.
- For example, a customer statement may list the information for the customer,
- provide text about current promotions, and provide side-by-side lists of payments and charges. A financial report may include disclaimers,
- charts, tables all with extensive formatting that matches corporate color schemes.</para>
+ <title>Which are the supported content types?</title>
+ <para>text/html</para>
+ <para>application/pdf</para>
+ <para>application/vnd.ms-excel</para>
+ <para>application/vnd.ms-word</para>
+ <para>application/vnd.ms-powerpoint</para>
</section>
</section>
View
66 framework/webtools/data/helpdata/HELP_BIRT_reports.xml
@@ -1,66 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
-
- <section>
- <title>How do I create BIRT report in OFBiz.</title>
- <para>Create new report</para>
- <para>Create Scripted Data Source</para>
- <para>Create Data Set that use Scripted Data Source</para>
- <para>Add output columns</para>
- <para>Add script to Data Set</para>
- <para>Bind report's element to Data Set</para>
- </section>
- <section>
- <title>How do I add script code to report.</title>
- <para>Report can use delegator, dispatcher and security object in script.</para>
- <para>Report can use same classpath with ofbiz.</para>
- </section>
- <section>
- <title>How do I send parameter to report.</title>
- <para>If report be rendered through view map, you can send parameter through attribute of request object, attribute's name "birtParameters" that is map.</para>
- <para>If report be rendered through e-mail, you can send parameter through service's parameter name is birtParameters.</para>
- </section>
- <section>
- <title>How do I send report through e-mail.</title>
- <para>Report can sent through email by using sendBirtMail service.</para>
- </section>
- <section>
- <title>How do I embed report to screen.</title>
- <para>Report can embeded in screen by using jsp tag, viewer and report tag, that can use in ftl file.</para>
- </section>
- <section>
- <title>What content's type that report supported.</title>
- <para>text/html</para>
- <para>application/pdf</para>
- <para>application/vnd.ms-excel</para>
- <para>application/vnd.ms-word</para>
- <para>application/vnd.ms-powerpoint</para>
- </section>
- <section>
- <title>How do I change report content's type</title>
- <para>If report be rendered through view map, can set content's type at content-type attribute of view map.</para>
- <para>If report be rendered through e-mail, can set content's type at service's parameter name is birtContentType.</para>
- </section>
-</section>
Please sign in to comment.
Something went wrong with that request. Please try again.