https://wiki.idempiere.org/w-en/api.php?action=feedcontributions&feedformat=atom&user=MbozemiDempiere en - User contributions [en]2026-09-30T22:14:03ZUser contributionsMediaWiki 1.35.2https://wiki.idempiere.org/w-en/index.php?title=NF14_Extensible_Report_Content_Generation&diff=24045NF14 Extensible Report Content Generation2026-09-12T20:48:52Z<p>Mbozem: </p>
<hr />
<div>IDEMPIERE-7070 introduces UI-independent and report-engine-independent extension points for generating and post-processing report content.<br />
<br />
The feature allows plug-ins to provide alternative report renderers and to enhance generated documents without depending on the ZK report viewer or modifying iDempiere core classes.<br />
<br />
== Purpose ==<br />
<br />
Before this change, the report extension mechanism was located in the ZK report viewer and exposed ZK- and Jasper-specific types.<br />
<br />
This caused several limitations:<br />
<br />
* The extension was not available to headless or server-side consumers.<br />
* Report-generation paths calling <code>ReportEngine</code> directly bypassed plug-in-provided output.<br />
* The mechanism was effectively tied to Jasper Reports.<br />
* Multiple independent document enhancements could not be combined cleanly because only one renderer could handle the request.<br />
* Preview and download names could expose the random suffix of an internal temporary Jasper file.<br />
<br />
A report may need several consecutive operations, for example:<br />
<br />
# Generate the initial PDF.<br />
# Add ZUGFeRD/Factur-X data.<br />
# Convert the document to PDF/A.<br />
# Add PDF attachments.<br />
# Add a watermark.<br />
# Digitally sign or encrypt the final document.<br />
<br />
IDEMPIERE-7070 separates initial report rendering from subsequent content processing, allowing these operations to be implemented by independent OSGi services and executed in a defined order.<br />
<br />
== Architecture ==<br />
<br />
Report content generation consists of two extension stages:<br />
<br />
<pre><br />
ReportContentRequest<br />
|<br />
v<br />
ranked IReportContentRendererFactory services<br />
|<br />
+-- first applicable renderer<br />
|<br />
+-- ReportEngine fallback<br />
|<br />
v<br />
initial report content<br />
|<br />
v<br />
all applicable IReportContentProcessor services<br />
in descending OSGi service-ranking order<br />
|<br />
v<br />
final processed content<br />
</pre><br />
<br />
=== Report content request ===<br />
<br />
<code>ReportContentRequest</code> is the common input for rendering and post-processing:<br />
<br />
<syntaxhighlight lang="java"><br />
public record ReportContentRequest(<br />
ReportEngine reportEngine,<br />
ProcessInfo processInfo,<br />
String title,<br />
boolean applyPostProcessing) {<br />
}<br />
</syntaxhighlight><br />
<br />
The three-argument constructor enables post-processing by default:<br />
<br />
<syntaxhighlight lang="java"><br />
ReportContentRequest request =<br />
new ReportContentRequest(reportEngine, processInfo, reportTitle);<br />
</syntaxhighlight><br />
<br />
Post-processing can be disabled explicitly when required:<br />
<br />
<syntaxhighlight lang="java"><br />
ReportContentRequest request =<br />
new ReportContentRequest(reportEngine, processInfo, reportTitle, false);<br />
</syntaxhighlight><br />
<br />
The report context preserves the relevant process information, including:<br />
<br />
* process parameters<br />
* record ID and record UUID<br />
* record selections<br />
* language<br />
* user and tenant context<br />
* transaction context<br />
* requested PDF filename<br />
<br />
=== Stage 1: report content rendering ===<br />
<br />
A plug-in can register an <code>IReportContentRendererFactory</code> OSGi service:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentRendererFactory {<br />
IReportContentRenderer createRenderer(ReportContentRequest request);<br />
}<br />
</syntaxhighlight><br />
<br />
Factories are evaluated in descending OSGi <code>service.ranking</code> order. A factory returns:<br />
<br />
* an <code>IReportContentRenderer</code> when it supports the request, or<br />
* <code>null</code> when it is not applicable.<br />
<br />
The first applicable renderer is selected.<br />
<br />
A renderer implements:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentRenderer {<br />
File getContent(String contentType, String fileExtension);<br />
<br />
ReportContentType[] getSupportedContentTypes();<br />
<br />
default int getRowCount() {<br />
return -1;<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Supported output types are described without any dependency on a UI toolkit:<br />
<br />
<syntaxhighlight lang="java"><br />
public record ReportContentType(<br />
String name,<br />
String fileExtension,<br />
String contentType) {<br />
}<br />
</syntaxhighlight><br />
<br />
An example Declarative Services registration is:<br />
<br />
<syntaxhighlight lang="java"><br />
@Component(<br />
service = IReportContentRendererFactory.class,<br />
immediate = true,<br />
property = "service.ranking:Integer=100"<br />
)<br />
public class CustomReportContentRendererFactory<br />
implements IReportContentRendererFactory {<br />
<br />
@Override<br />
public IReportContentRenderer createRenderer(<br />
ReportContentRequest request) {<br />
if (!supports(request))<br />
return null;<br />
<br />
return new CustomReportContentRenderer(request);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
The default Jasper renderer is supplied by the <code>org.adempiere.report.jasper</code> bundle with service ranking <code>0</code>. It is one provider of the generic API; the extension point is not limited to Jasper Reports.<br />
<br />
The Jasper renderer supports the existing report viewer formats, including:<br />
<br />
* PDF<br />
* HTML<br />
* CSV<br />
* XLS<br />
* XLSX<br />
* SSV<br />
<br />
If no registered factory handles the request, Core uses the standard <code>ReportEngine</code> as a fallback. The fallback supports PDF, HTML, CSV, XLS and XLSX.<br />
<br />
=== Stage 2: report content post-processing ===<br />
<br />
After rendering, the generated content is passed through every applicable <code>IReportContentProcessor</code> service:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentProcessor {<br />
<br />
boolean isApplicable(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension);<br />
<br />
File process(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File input);<br />
}<br />
</syntaxhighlight><br />
<br />
Processors are executed in descending OSGi <code>service.ranking</code> order. Each processor receives the result of the previous processor.<br />
<br />
A processor may:<br />
<br />
* modify the input file and return the same file, or<br />
* create and return a new file.<br />
<br />
It must not return <code>null</code>. A null result is treated as an error.<br />
<br />
Typical processor use cases include:<br />
<br />
* ZUGFeRD/Factur-X data<br />
* PDF/A conversion<br />
* PDF attachments<br />
* watermarks<br />
* digital signatures<br />
* encryption<br />
* other document transformations<br />
<br />
An example registration is:<br />
<br />
<syntaxhighlight lang="java"><br />
@Component(<br />
service = IReportContentProcessor.class,<br />
immediate = true,<br />
property = "service.ranking:Integer=100"<br />
)<br />
public class CustomPDFProcessor<br />
implements IReportContentProcessor {<br />
<br />
@Override<br />
public boolean isApplicable(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension) {<br />
return "application/pdf".equals(contentType)<br />
|| "pdf".equalsIgnoreCase(fileExtension);<br />
}<br />
<br />
@Override<br />
public File process(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File input) {<br />
// Modify input or create a new output file.<br />
return input;<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
The processor chain is applied both to custom renderer output and to content generated by the standard <code>ReportEngine</code> fallback.<br />
<br />
== Central Core API ==<br />
<br />
The common API is provided through <code>org.adempiere.base.Core</code>.<br />
<br />
The main entry points are:<br />
<br />
<syntaxhighlight lang="java"><br />
IReportContentRenderer getReportContentRenderer(<br />
ReportContentRequest request);<br />
<br />
File getReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension);<br />
<br />
File getReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File outputFile);<br />
<br />
File processReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File content);<br />
</syntaxhighlight><br />
<br />
When an output file is supplied, only the final processed content is copied to that target. Intermediate renderer or processor files are not copied to it.<br />
<br />
Failures during report generation are propagated instead of silently returning an incomplete result.<br />
<br />
== Report-generation paths using the API ==<br />
<br />
The pull request routes the following report-generation paths through the common API:<br />
<br />
* ZK report preview and export<br />
* the legacy direct Jasper viewer<br />
* report email attachments<br />
* report archiving<br />
* workflow reports<br />
* server-side exports<br />
* document PDF generation<br />
* batch-print processes<br />
* payment and remittance printing<br />
* dunning and invoice printing<br />
* relevant ZK report and print processes<br />
<br />
Document generation for orders, invoices, shipments, distribution orders and RFQ responses is included in the affected server-side paths.<br />
<br />
The existing direct-printer path remains unchanged.<br />
<br />
== Report viewer behavior ==<br />
<br />
The ZK report viewer uses the common content renderer and processor chain.<br />
<br />
Processed content is cached for each combination of MIME type and file extension. Preview, export, email and archive actions can therefore reuse the same final result.<br />
<br />
This is important for processors such as:<br />
<br />
* document signing<br />
* attachment generation<br />
* ZUGFeRD/Factur-X generation<br />
* PDF/A conversion<br />
<br />
Without caching, such processors could be executed more than once for the same viewer output.<br />
<br />
The report viewer also:<br />
<br />
* shows only formats supported by the active renderer or report engine;<br />
* preserves the original <code>ProcessInfo</code>;<br />
* preserves record UUIDs;<br />
* refreshes native print data after changing the print format;<br />
* uses the logical report name for preview and download media;<br />
* retains unique filenames for internal temporary files.<br />
<br />
Consequently, users no longer see the random suffix generated for an internal Jasper temporary file in the preview or download filename.<br />
<br />
== Compatibility ==<br />
<br />
* Existing Jasper reports are handled by the default renderer in the Jasper bundle.<br />
* The API is not limited to Jasper Reports.<br />
* Other report engines can register their own renderer factory.<br />
* Requests without a matching renderer fall back to <code>ReportEngine</code>.<br />
* Installations without an <code>IReportContentProcessor</code> receive the original generated content unchanged.<br />
* Headless installations can use the renderer and processor APIs without the ZK bundle.<br />
* Existing report viewer export formats are retained.<br />
* Legacy <code>ZkJRViewer</code> adapters are retained.<br />
* Direct-printer behavior is unchanged.<br />
* No database migration is required.<br />
<br />
== Example use cases ==<br />
<br />
=== ZUGFeRD/Factur-X ===<br />
<br />
A processor can embed ZUGFeRD/Factur-X XML into a PDF produced by any renderer.<br />
<br />
This integrates electronic invoice generation into the normal workflow:<br />
<br />
<pre><br />
Print button<br />
-> Preview<br />
-> E-mail<br />
-> Archive<br />
</pre><br />
<br />
The same processor can be applied to a PDF produced by:<br />
<br />
* the native report engine<br />
* Jasper Reports<br />
* a FreeMarker-based renderer<br />
* another custom report engine<br />
<br />
This complements the existing [[Plugin:_ZUGFeRDXInvoice|ZUGFeRD/XInvoice plug-in]] by allowing its result to participate in the standard report workflow.<br />
<br />
=== PDF attachments ===<br />
<br />
A processor can attach additional PDF documents to the generated report. For example, a drawing attached to an order can be included in the final order PDF.<br />
<br />
=== Alternative report engines ===<br />
<br />
The API was tested conceptually and practically with a FreeMarker-based print-template engine. Such a plug-in can examine the print format in <code>ReportContentRequest</code>, return its own renderer and use the same post-processing pipeline as Jasper or the native report engine.<br />
<br />
== Validation ==<br />
<br />
=== Automated validation ===<br />
<br />
The pull request contains integration coverage for:<br />
<br />
* renderer selection by OSGi service ranking<br />
* fallback to the next renderer factory<br />
* fallback to the standard report engine<br />
* default Jasper renderer registration<br />
* supported output formats<br />
* processor ordering<br />
* processor applicability<br />
* invalid null processor results<br />
* enabling and disabling post-processing<br />
* processed-content caching<br />
* propagation of report-generation failures<br />
<br />
After fixes made during review, the reported validation results were:<br />
<br />
* <code>ServerReportCtlTest</code>: 1 test, 0 failures, 0 errors<br />
* <code>ReportViewerContentRendererFactoryTest</code>: 9 tests, 0 failures, 0 errors<br />
* complete 63-module Maven <code>verify</code> reactor: '''BUILD SUCCESS'''<br />
* <code>git diff --check</code>: passed<br />
<br />
Earlier failures concerning the requested PDF filename and missing server-side print data were fixed before the successful final validation.<br />
<br />
=== Integration testing ===<br />
<br />
The reported integration-test environment was:<br />
<br />
{| class="wikitable"<br />
! Component<br />
! Value<br />
|-<br />
| iDempiere<br />
| Version 14 development workspace<br />
|-<br />
| Java<br />
| OpenJDK 17.0.19<br />
|-<br />
| Runtime<br />
| Eclipse PDE<br />
|-<br />
| Database<br />
| PostgreSQL<br />
|-<br />
| Database migration level<br />
| <code>202607261257_IDEMPIERE-6552.sql</code><br />
|-<br />
| ZK<br />
| 10.3.0.1<br />
|-<br />
| Locale<br />
| <code>de_DE</code><br />
|}<br />
<br />
The integration test used:<br />
<br />
* a FreeMarker report renderer;<br />
* a ZUGFeRD/Factur-X content processor;<br />
* invoice <code>C_Invoice_ID=103</code>.<br />
<br />
The following flow was tested:<br />
<br />
# Generate an invoice using the normal Print button.<br />
# Render the invoice through the new report content pipeline.<br />
# Post-process the generated PDF through <code>IReportContentProcessor</code>.<br />
# Embed Factur-X/ZUGFeRD XML into the PDF.<br />
# Combine the FreeMarker renderer with the ZUGFeRD processor.<br />
<br />
Reported result:<br />
<br />
* <code>Invoice_Header.pdf</code> was generated successfully.<br />
* The PDF contained an embedded <code>factur-x.xml</code> attachment.<br />
* The embedded XML was 9,711 bytes and began with a valid <code>CrossIndustryInvoice</code> document.<br />
* The ZUGFeRD processor worked independently of the selected renderer.<br />
* No remaining ZUGFeRD, PostgreSQL or PDFBox errors were reported in the server log after the final test.<br />
<br />
Further review and broader testing of the affected report-generation paths and representative processor combinations are still recommended before merge.<br />
<br />
== Known limitation ==<br />
<br />
Multi-record Jasper report handling is intentionally outside the scope of this change and is tracked separately in [https://idempiere.atlassian.net/browse/IDEMPIERE-7073 IDEMPIERE-7073].<br />
<br />
== Related work and examples ==<br />
<br />
* [https://idempiere.atlassian.net/browse/IDEMPIERE-7070 IDEMPIERE-7070 – Make report content generation extensible through OSGi]<br />
* [https://github.com/idempiere/idempiere/pull/3318 Pull request #3318]<br />
* [https://idempiere.atlassian.net/browse/IDEMPIERE-6069 IDEMPIERE-6069 – related composable report-processing requirement]<br />
* [[Plugin:_ZUGFeRDXInvoice|ZUGFeRD/XInvoice plug-in]]<br />
* [https://github.com/mbozem/idempiere-print-template/tree/IDEMPIERE-7070 FreeMarker renderer integration branch]<br />
* [https://github.com/mbozem/auler.gmbh.zugferdxinvoice/tree/agent/idempiere-14-compatibility ZUGFeRD/Factur-X integration branch]<br />
<br />
<br />
[[Category:New Features]]<br />
[[Category:New Features w14]]<br />
[[Category:New Features Development]]<br />
[[Category:New Features Technical]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=NF14_Extensible_Report_Content_Generation&diff=24044NF14 Extensible Report Content Generation2026-09-12T20:46:38Z<p>Mbozem: </p>
<hr />
<div>IDEMPIERE-7070 introduces UI-independent and report-engine-independent extension points for generating and post-processing report content.<br />
<br />
The feature allows plug-ins to provide alternative report renderers and to enhance generated documents without depending on the ZK report viewer or modifying iDempiere core classes.<br />
<br />
== Purpose ==<br />
<br />
Before this change, the report extension mechanism was located in the ZK report viewer and exposed ZK- and Jasper-specific types.<br />
<br />
This caused several limitations:<br />
<br />
* The extension was not available to headless or server-side consumers.<br />
* Report-generation paths calling <code>ReportEngine</code> directly bypassed plug-in-provided output.<br />
* The mechanism was effectively tied to Jasper Reports.<br />
* Multiple independent document enhancements could not be combined cleanly because only one renderer could handle the request.<br />
* Preview and download names could expose the random suffix of an internal temporary Jasper file.<br />
<br />
A report may need several consecutive operations, for example:<br />
<br />
# Generate the initial PDF.<br />
# Add ZUGFeRD/Factur-X data.<br />
# Convert the document to PDF/A.<br />
# Add PDF attachments.<br />
# Add a watermark.<br />
# Digitally sign or encrypt the final document.<br />
<br />
IDEMPIERE-7070 separates initial report rendering from subsequent content processing, allowing these operations to be implemented by independent OSGi services and executed in a defined order.<br />
<br />
== Architecture ==<br />
<br />
Report content generation consists of two extension stages:<br />
<br />
<pre><br />
ReportContentRequest<br />
|<br />
v<br />
ranked IReportContentRendererFactory services<br />
|<br />
+-- first applicable renderer<br />
|<br />
+-- ReportEngine fallback<br />
|<br />
v<br />
initial report content<br />
|<br />
v<br />
all applicable IReportContentProcessor services<br />
in descending OSGi service-ranking order<br />
|<br />
v<br />
final processed content<br />
</pre><br />
<br />
=== Report content request ===<br />
<br />
<code>ReportContentRequest</code> is the common input for rendering and post-processing:<br />
<br />
<syntaxhighlight lang="java"><br />
public record ReportContentRequest(<br />
ReportEngine reportEngine,<br />
ProcessInfo processInfo,<br />
String title,<br />
boolean applyPostProcessing) {<br />
}<br />
</syntaxhighlight><br />
<br />
The three-argument constructor enables post-processing by default:<br />
<br />
<syntaxhighlight lang="java"><br />
ReportContentRequest request =<br />
new ReportContentRequest(reportEngine, processInfo, reportTitle);<br />
</syntaxhighlight><br />
<br />
Post-processing can be disabled explicitly when required:<br />
<br />
<syntaxhighlight lang="java"><br />
ReportContentRequest request =<br />
new ReportContentRequest(reportEngine, processInfo, reportTitle, false);<br />
</syntaxhighlight><br />
<br />
The report context preserves the relevant process information, including:<br />
<br />
* process parameters<br />
* record ID and record UUID<br />
* record selections<br />
* language<br />
* user and tenant context<br />
* transaction context<br />
* requested PDF filename<br />
<br />
=== Stage 1: report content rendering ===<br />
<br />
A plug-in can register an <code>IReportContentRendererFactory</code> OSGi service:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentRendererFactory {<br />
IReportContentRenderer createRenderer(ReportContentRequest request);<br />
}<br />
</syntaxhighlight><br />
<br />
Factories are evaluated in descending OSGi <code>service.ranking</code> order. A factory returns:<br />
<br />
* an <code>IReportContentRenderer</code> when it supports the request, or<br />
* <code>null</code> when it is not applicable.<br />
<br />
The first applicable renderer is selected.<br />
<br />
A renderer implements:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentRenderer {<br />
File getContent(String contentType, String fileExtension);<br />
<br />
ReportContentType[] getSupportedContentTypes();<br />
<br />
default int getRowCount() {<br />
return -1;<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Supported output types are described without any dependency on a UI toolkit:<br />
<br />
<syntaxhighlight lang="java"><br />
public record ReportContentType(<br />
String name,<br />
String fileExtension,<br />
String contentType) {<br />
}<br />
</syntaxhighlight><br />
<br />
An example Declarative Services registration is:<br />
<br />
<syntaxhighlight lang="java"><br />
@Component(<br />
service = IReportContentRendererFactory.class,<br />
immediate = true,<br />
property = "service.ranking:Integer=100"<br />
)<br />
public class CustomReportContentRendererFactory<br />
implements IReportContentRendererFactory {<br />
<br />
@Override<br />
public IReportContentRenderer createRenderer(<br />
ReportContentRequest request) {<br />
if (!supports(request))<br />
return null;<br />
<br />
return new CustomReportContentRenderer(request);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
The default Jasper renderer is supplied by the <code>org.adempiere.report.jasper</code> bundle with service ranking <code>0</code>. It is one provider of the generic API; the extension point is not limited to Jasper Reports.<br />
<br />
The Jasper renderer supports the existing report viewer formats, including:<br />
<br />
* PDF<br />
* HTML<br />
* CSV<br />
* XLS<br />
* XLSX<br />
* SSV<br />
<br />
If no registered factory handles the request, Core uses the standard <code>ReportEngine</code> as a fallback. The fallback supports PDF, HTML, CSV, XLS and XLSX.<br />
<br />
=== Stage 2: report content post-processing ===<br />
<br />
After rendering, the generated content is passed through every applicable <code>IReportContentProcessor</code> service:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentProcessor {<br />
<br />
boolean isApplicable(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension);<br />
<br />
File process(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File input);<br />
}<br />
</syntaxhighlight><br />
<br />
Processors are executed in descending OSGi <code>service.ranking</code> order. Each processor receives the result of the previous processor.<br />
<br />
A processor may:<br />
<br />
* modify the input file and return the same file, or<br />
* create and return a new file.<br />
<br />
It must not return <code>null</code>. A null result is treated as an error.<br />
<br />
Typical processor use cases include:<br />
<br />
* ZUGFeRD/Factur-X data<br />
* PDF/A conversion<br />
* PDF attachments<br />
* watermarks<br />
* digital signatures<br />
* encryption<br />
* other document transformations<br />
<br />
An example registration is:<br />
<br />
<syntaxhighlight lang="java"><br />
@Component(<br />
service = IReportContentProcessor.class,<br />
immediate = true,<br />
property = "service.ranking:Integer=100"<br />
)<br />
public class CustomPDFProcessor<br />
implements IReportContentProcessor {<br />
<br />
@Override<br />
public boolean isApplicable(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension) {<br />
return "application/pdf".equals(contentType)<br />
|| "pdf".equalsIgnoreCase(fileExtension);<br />
}<br />
<br />
@Override<br />
public File process(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File input) {<br />
// Modify input or create a new output file.<br />
return input;<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
The processor chain is applied both to custom renderer output and to content generated by the standard <code>ReportEngine</code> fallback.<br />
<br />
== Central Core API ==<br />
<br />
The common API is provided through <code>org.adempiere.base.Core</code>.<br />
<br />
The main entry points are:<br />
<br />
<syntaxhighlight lang="java"><br />
IReportContentRenderer getReportContentRenderer(<br />
ReportContentRequest request);<br />
<br />
File getReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension);<br />
<br />
File getReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File outputFile);<br />
<br />
File processReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File content);<br />
</syntaxhighlight><br />
<br />
When an output file is supplied, only the final processed content is copied to that target. Intermediate renderer or processor files are not copied to it.<br />
<br />
Failures during report generation are propagated instead of silently returning an incomplete result.<br />
<br />
== Report-generation paths using the API ==<br />
<br />
The pull request routes the following report-generation paths through the common API:<br />
<br />
* ZK report preview and export<br />
* the legacy direct Jasper viewer<br />
* report email attachments<br />
* report archiving<br />
* workflow reports<br />
* server-side exports<br />
* document PDF generation<br />
* batch-print processes<br />
* payment and remittance printing<br />
* dunning and invoice printing<br />
* relevant ZK report and print processes<br />
<br />
Document generation for orders, invoices, shipments, distribution orders and RFQ responses is included in the affected server-side paths.<br />
<br />
The existing direct-printer path remains unchanged.<br />
<br />
== Report viewer behavior ==<br />
<br />
The ZK report viewer uses the common content renderer and processor chain.<br />
<br />
Processed content is cached for each combination of MIME type and file extension. Preview, export, email and archive actions can therefore reuse the same final result.<br />
<br />
This is important for processors such as:<br />
<br />
* document signing<br />
* attachment generation<br />
* ZUGFeRD/Factur-X generation<br />
* PDF/A conversion<br />
<br />
Without caching, such processors could be executed more than once for the same viewer output.<br />
<br />
The report viewer also:<br />
<br />
* shows only formats supported by the active renderer or report engine;<br />
* preserves the original <code>ProcessInfo</code>;<br />
* preserves record UUIDs;<br />
* refreshes native print data after changing the print format;<br />
* uses the logical report name for preview and download media;<br />
* retains unique filenames for internal temporary files.<br />
<br />
Consequently, users no longer see the random suffix generated for an internal Jasper temporary file in the preview or download filename.<br />
<br />
== Compatibility ==<br />
<br />
* Existing Jasper reports are handled by the default renderer in the Jasper bundle.<br />
* The API is not limited to Jasper Reports.<br />
* Other report engines can register their own renderer factory.<br />
* Requests without a matching renderer fall back to <code>ReportEngine</code>.<br />
* Installations without an <code>IReportContentProcessor</code> receive the original generated content unchanged.<br />
* Headless installations can use the renderer and processor APIs without the ZK bundle.<br />
* Existing report viewer export formats are retained.<br />
* Legacy <code>ZkJRViewer</code> adapters are retained.<br />
* Direct-printer behavior is unchanged.<br />
* No database migration is required.<br />
<br />
== Example use cases ==<br />
<br />
=== ZUGFeRD/Factur-X ===<br />
<br />
A processor can embed ZUGFeRD/Factur-X XML into a PDF produced by any renderer.<br />
<br />
This integrates electronic invoice generation into the normal workflow:<br />
<br />
<pre><br />
Print button<br />
-> Preview<br />
-> E-mail<br />
-> Archive<br />
</pre><br />
<br />
The same processor can be applied to a PDF produced by:<br />
<br />
* the native report engine<br />
* Jasper Reports<br />
* a FreeMarker-based renderer<br />
* another custom report engine<br />
<br />
This complements the existing [[Plugin:_ZUGFeRDXInvoice|ZUGFeRD/XInvoice plug-in]] by allowing its result to participate in the standard report workflow.<br />
<br />
=== PDF attachments ===<br />
<br />
A processor can attach additional PDF documents to the generated report. For example, a drawing attached to an order can be included in the final order PDF.<br />
<br />
=== Alternative report engines ===<br />
<br />
The API was tested conceptually and practically with a FreeMarker-based print-template engine. Such a plug-in can examine the print format in <code>ReportContentRequest</code>, return its own renderer and use the same post-processing pipeline as Jasper or the native report engine.<br />
<br />
== Validation ==<br />
<br />
=== Automated validation ===<br />
<br />
The pull request contains integration coverage for:<br />
<br />
* renderer selection by OSGi service ranking<br />
* fallback to the next renderer factory<br />
* fallback to the standard report engine<br />
* default Jasper renderer registration<br />
* supported output formats<br />
* processor ordering<br />
* processor applicability<br />
* invalid null processor results<br />
* enabling and disabling post-processing<br />
* processed-content caching<br />
* propagation of report-generation failures<br />
<br />
After fixes made during review, the reported validation results were:<br />
<br />
* <code>ServerReportCtlTest</code>: 1 test, 0 failures, 0 errors<br />
* <code>ReportViewerContentRendererFactoryTest</code>: 9 tests, 0 failures, 0 errors<br />
* complete 63-module Maven <code>verify</code> reactor: '''BUILD SUCCESS'''<br />
* <code>git diff --check</code>: passed<br />
<br />
Earlier failures concerning the requested PDF filename and missing server-side print data were fixed before the successful final validation.<br />
<br />
=== Integration testing ===<br />
<br />
The reported integration-test environment was:<br />
<br />
{| class="wikitable"<br />
! Component<br />
! Value<br />
|-<br />
| iDempiere<br />
| Version 14 development workspace<br />
|-<br />
| Java<br />
| OpenJDK 17.0.19<br />
|-<br />
| Runtime<br />
| Eclipse PDE<br />
|-<br />
| Database<br />
| PostgreSQL<br />
|-<br />
| Database migration level<br />
| <code>202607261257_IDEMPIERE-6552.sql</code><br />
|-<br />
| ZK<br />
| 10.3.0.1<br />
|-<br />
| Locale<br />
| <code>de_DE</code><br />
|}<br />
<br />
The integration test used:<br />
<br />
* a FreeMarker report renderer;<br />
* a ZUGFeRD/Factur-X content processor;<br />
* invoice <code>C_Invoice_ID=103</code>.<br />
<br />
The following flow was tested:<br />
<br />
# Generate an invoice using the normal Print button.<br />
# Render the invoice through the new report content pipeline.<br />
# Post-process the generated PDF through <code>IReportContentProcessor</code>.<br />
# Embed Factur-X/ZUGFeRD XML into the PDF.<br />
# Combine the FreeMarker renderer with the ZUGFeRD processor.<br />
<br />
Reported result:<br />
<br />
* <code>Invoice_Header.pdf</code> was generated successfully.<br />
* The PDF contained an embedded <code>factur-x.xml</code> attachment.<br />
* The embedded XML was 9,711 bytes and began with a valid <code>CrossIndustryInvoice</code> document.<br />
* The ZUGFeRD processor worked independently of the selected renderer.<br />
* No remaining ZUGFeRD, PostgreSQL or PDFBox errors were reported in the server log after the final test.<br />
<br />
Further review and broader testing of the affected report-generation paths and representative processor combinations are still recommended before merge.<br />
<br />
== Known limitation ==<br />
<br />
Multi-record Jasper report handling is intentionally outside the scope of this change and is tracked separately in [https://idempiere.atlassian.net/browse/IDEMPIERE-7073 IDEMPIERE-7073].<br />
<br />
== Related work and examples ==<br />
<br />
* [https://idempiere.atlassian.net/browse/IDEMPIERE-7070 IDEMPIERE-7070 – Make report content generation extensible through OSGi]<br />
* [https://github.com/idempiere/idempiere/pull/3318 Pull request #3318]<br />
* [https://idempiere.atlassian.net/browse/IDEMPIERE-6069 IDEMPIERE-6069 – related composable report-processing requirement]<br />
* [[Plugin:_ZUGFeRDXInvoice|ZUGFeRD/XInvoice plug-in]]<br />
* [https://github.com/mbozem/idempiere-print-template/tree/IDEMPIERE-7070 FreeMarker renderer integration branch]<br />
* [https://github.com/mbozem/auler.gmbh.zugferdxinvoice/tree/agent/idempiere-14-compatibility ZUGFeRD/Factur-X integration branch]<br />
<br />
== Tracking information ==<br />
<br />
{| class="wikitable"<br />
! Item<br />
! Value<br />
|-<br />
| Jira issue<br />
| [https://idempiere.atlassian.net/browse/IDEMPIERE-7070 IDEMPIERE-7070]<br />
|-<br />
| Issue type<br />
| Improvement<br />
|-<br />
| Priority<br />
| Minor<br />
|-<br />
| Jira status<br />
| Peer Review Queue<br />
|-<br />
| Reporter / assignee<br />
| Markus Bozem<br />
|-<br />
| Created<br />
| 29 July 2026<br />
|-<br />
| Pull request<br />
| [https://github.com/idempiere/idempiere/pull/3318 #3318]<br />
|-<br />
| Pull request target<br />
| <code>master</code><br />
|-<br />
| Pull request status<br />
| Open — not merged<br />
|-<br />
| Pull request scope as of 16 August 2026<br />
| 37 changed files, 1,526 additions and 495 deletions<br />
|}<br />
<br />
[[Category:New Features]]<br />
[[Category:New Features w14]]<br />
[[Category:New Features Development]]<br />
[[Category:New Features Technical]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=User:Mbozem&diff=24043User:Mbozem2026-09-11T16:51:36Z<p>Mbozem: /* Kontaktdaten */</p>
<hr />
<div>{{Userboxtop}}<br />
{{User real name|Markus Bozem}}<br />
{{User Living In Germany}}<br />
{{User en}}<br />
{{User de}}<br />
{{User developer}}<br />
{{User GitHub|https://github.com/mbozem}}<br />
{{Userboxbottom}}<br />
<br />
== Contact ==<br />
<br />
[mailto:mbozem@bozem.de E-Mail]<br><br />
[http://sps-schutzplanken.de SPS Schutzplanken GmbH]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=User:Mbozem&diff=24042User:Mbozem2026-09-11T16:37:19Z<p>Mbozem: /* Kontaktdaten */</p>
<hr />
<div>== Kontaktdaten ==<br />
<br />
Markus Bozem<br><br />
Ulmenstraße 6<br><br />
63808 Haibach<br />
<br />
[mailto:mbozem@bozem.de Email]<br />
[http://www.markus-bozem.de Homepage]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=Creating_reports_using_JasperReports&diff=23979Creating reports using JasperReports2026-08-16T17:27:08Z<p>Mbozem: </p>
<hr />
<div>This is a guide to the JasperReports library that is included with iDempiere. The focus is on the standard reporting mechanism, but you can also design more complex reports using JasperSoft Studio as described [[Create reports using JasperSoft Studio|here]].<br />
=Introduction=<br />
iDempiere includes the Jaspersoft reporting software library as standard to produce reports in a simple format from many Windows, such as Business Partner Details, Bank/Cash, and so on. <br />
<br />
You can also use the embedded JasperReports engine to generate reports in your own customized format by using JasperSoft Studio to design them.<br />
<br />
=Standard Reporting=<br />
==Ready-made reports==<br />
Many iDempiere Windows include standard, ready-made tabular reports that can be generated from the Report button on the Toolbar (or type Alt-R). Some Windows, for example ''Invoices (Customer)'', also have a Print button (Alt-P) that produces a formatted page.<br />
<br />
By default the standard report format includes features like:<br />
* Zoom across to related documents (e.g. zoom to a Business Partner from the report);<br />
* Drill down using hyperlinks in HTML reports;<br />
* Export to HTML, PDF, and Excel.<br />
<br />
You can see the full list of ready-made reports by logging in as System/System role, then select ''Report&Process'' and execute an advanced query with the filter ''Report=Yes'' to select the reports. <br />
<br />
Use these ready-made reports as a guide to create your own.<br />
==Customise a standard report==<br />
You can customise these reports and prints using the Toolbox icon from the print-preview window to change:<br />
* Add and remove columns;<br />
* Page format and orientation: A4 Landscape for example;<br />
* Font: serif or sans serif;<br />
* Display order of the items on the page;<br />
* Sort order of the rows or pages;<br />
* Format of the columns: alignment, width, colour, and so on.<br />
<br />
Once you have made your changes, save the new print format and re-create the print-out.<br />
==Report Wizard==<br />
iDempiere also provides a Report Wizard using the Wizard icon which provides more functionality to customise the standard reports, in particular:<br />
* Grouping criteria: group by date or by customer, for example;<br />
* Summary Fields: provides aggregate functions like sum, count, minimum, maximum, mean, variance, and standard deviation;<br />
* Copy Print Format: make a copy of the standard format of the ready-made reports and then change the format to suit your requirements, leaving the original print format intact.<br />
<br />
==Reporting selected records==<br />
<br />
JasperReports can access multiple records selected in an iDempiere window through the T_Selection table. The current process instance available through the AD_PINSTANCE_ID Jasper parameter.<br />
<br />
For queries supporting both individual records and multiple selections, use RECORD_ID for the individual record and T_Selection for the record collection.<br />
<br />
See [[Create reports using JasperSoft Studio#Filtering by records selected in iDempiere|Filtering by records selected in iDempiere]] for parameter declarations and SQL examples.<br />
<br />
==Create new reports using built-in reporting functionality==<br />
You can also create your own reports using iDempiere's built-in reporting functionality by creating a Report View for a database table or a more complex database. Follow the [[Report View|guidelines here]].<br />
<br />
=Customised reporting=<br />
==Create new reports using JasperSoft Studio==<br />
The standard reporting mechanism is suitable for simple reports, but using the built-in Print Format tools to customise layouts and create new reports can be cumbersome and time-consuming.<br />
<br />
If you want to create more sophisticated reports and print-outs with professionally designed layouts, fonts, colours and logos, you should rather use JasperSoft Studio to do the design, then load the JRXML report definition into iDempiere for execution by the JasperReports engine. <br />
<br />
Follow these guides:<br />
* [[Create reports using JasperSoft Studio]]<br />
* [https://www.youtube.com/watch?v=qupDLprUoJE Video about JasperSoft Studio by Evenos]<br />
* [https://www.youtube.com/watch?v=B9mtzNm7CRc Short video about JasperSoft Studio].<br />
<br />
==JasperReports plug-in by Niemcor==<br />
See this [http://youtu.be/JW7WmuknBUo video by Red1] demonstrating a useful JasperReports plug-in by Niemcor, with ready made sample reports. Follow the [[Plugin:_JasperReports|instructions here]].<br />
<br />
=See also=<br />
* [[Making fonts available to your JasperReports]]<br />
* [[Finding resources in JasperReports|Making resources such as images and language files available to your JasperReports]]<br />
* [[Multi-Lingual Jasper]]<br />
* [http://www.adempiere.com/ADempiere/Compiere_JasperReports_Integration_HowTo Link to historical Compiere documentation on JasperReports]<br />
* [http://www.adempiere.com/HOWTO_Use_Jasper_On_Financial_Reports Another link to historical Compiere documentation about Financial Reports]<br />
<br />
[[Category: JasperReports]]<br />
[[Category: Development|P]]<br />
[[Category: Developer documentation]]<br />
[[Category:Reference]]<br />
[[Category: NeedsToBeUpdated]]<br />
<br />
[[en:Creating reports using JasperReports]] <br />
[[es:Crear reportes usando JasperReports]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=Create_reports_using_JasperSoft_Studio&diff=23978Create reports using JasperSoft Studio2026-08-16T17:23:45Z<p>Mbozem: </p>
<hr />
<div>This guide explains how to use JasperSoft Studio to create complex reports and print-outs for use by the JasperReports engine embedded in iDempiere. This is an alternative to using the standard built-in reports [[Creating reports using JasperReports| described here]].<br />
<br />
=Introduction=<br />
The standard reporting mechanism is suitable for simple reports, but creating complex reports with sophisticated layouts can be difficult and time-consuming using the built-in Print Format tools, so rather use JasperSoft Studio to do the design of sophisticated reports and print-outs with professionally designed layouts, fonts, colours and logos, then load the JRXML report definition into iDempiere for execution by the JasperReports engine.<br />
<br />
The guide is based on [https://www.youtube.com/watch?v=qupDLprUoJE this video] by Evenos.<br />
=How to do it=<br />
==JasperSoft Studio==<br />
If you have not already done so, install JasperSoft Studio:<br />
* Download and install the Community Edition of JasperSoft Studio from the [https://community.jaspersoft.com/project/jaspersoft-studio download page] ('''note:''' don't download the older iReport Designer as this has been deprecated in favour of JasperSoft Studio);<br />
* Follow the installation instructions [https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v640/installing-jaspersoft-studio here]. JasperSoft Studio is built on the same framework as the Eclipse IDE so the [https://community.jaspersoft.com/documentation/v640/tibco-jaspersoft-studio-user-guide installation and usage is the same].<br />
<br />
==Create a report==<br />
===Database Adapter===<br />
The first step is to create a database adapter to connect JasperSoft Studio to your instance of the iDempiere database server:<br />
<br />
* Start up JasperSoft Studio<br />
* Delete the two unnecessary Data Adapters (called ''One Empty Record'' and ''Sample DB'')<br />
* Create a new Data Adapter to connect to the iDempiere database: '''Create Data Adapter > Database JDBC Connection > Next > '''<br />
** '''Name:''' iDempiere Data Adapter<br />
** '''JDBC Driver:''' org.postgresql.Driver<br />
** '''JDBC URL:''' jdbc:postgresql://localhost:5432/idempiere (use ''localhost'' if the database is on the same machine as JasperSoft Studio, otherwise replace ''localhost'' with the name of the database server)<br />
** '''Username:''' adempiere (the same username that was used when iDempiere was installed)<br />
** '''Password:''' *********<br />
* Click on '''Test''' to test the connection parameters<br />
* Click '''Finish''' if all is well<br />
<br />
This only has to be done once. Thereafter you will use the same adapter to develop your reports.<br />
===Design the report===<br />
Now you can create the JasperReport:<br />
* Click on the ''New JasperReport'' icon<br />
* Select a Report Template (e.g. Blank Format A4)<br />
** '''Parent directory:''' MyReports (in the JaspersoftWorkspace), or create a new JasperReports Project<br />
** '''File name:''' Invoice.jrxml (JRXML is the XML format used by JasperReports)<br />
* Open the ''adempiere (CURRENT)'' schema to see all the tables and views that can be used in the report (note that you can also create additional database views in the schema for your own reports)<br />
* In the Texts box (to the right of the schemas), write a SQL SELECT statement to assemble the items for the report, for example:<br />
SELECT a.documentno, a.docstatus, b.name, b.logo_id FROM adempiere.c_invoice a, adempiere.c_bpartner b WHERE a.c_bpartner_id=b.c_bpartner_id<br />
* The SELECT can be as detailed and as complex as you require<br />
* Click ''Next >'' to choose the fields from the SELECT that you want to see in the report<br />
* Click ''Next >'' and add any GROUP BY clauses if required<br />
* Click ''Finish'' to generate the basic report definition<br />
* Use the Preview tab to run the report, then Save it regularly while you work on it.<br />
<br />
Follow [https://www.youtube.com/watch?v=qupDLprUoJE the video] to complete the design of the report, and see the [https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v640/getting-started-jaspersoft-studio JasperSoft Studio documentation] for more details. <br />
===Compile the report===<br />
When you are done, compile the report for use by iDempiere:<br />
* Select the Design Tab<br />
* Click on the ''Compile Report'' button (above the report design)<br />
<br />
This will generate the report binary file ''Invoice.jasper'' from the resource ''Invoice.jrxml''. This is the file that you will upload to iDempiere (see below). Note that you can upload either the binary ''.jasper'' or the XML description ''.JRXML'' because iDempiere understands both, but the binary may be more efficient, and it may avoid version inconsistencies between the JasperReports compiler in iDempiere and the one in JasperSoft Studio.<br />
<br />
==Installing the report==<br />
Once you are happy with the report, you can install it in iDempiere as follows:<br />
* Login as System/System<br />
* Select ''Report & Process'' and create a new entry:<br />
** '''Search Key:''' InvoiceJasperReport<br />
** '''Name:''' InvoiceJasperReport<br />
** '''Data Access Level:''' Client+Organisation (it is not useful to the System user)<br />
** '''Report:''' check the box for completeness<br />
** '''Class Name:''' org.compiere.report.ReportStarter (note that this is case sensitive)<br />
** '''Jasper Report:''' attachment:Invoice.jasper (this is the binary that was created above)<br />
* Save the record<br />
* Now click on the Attachment icon (the paperclip on the toolbar) and load the binary from the JaspersoftWorkspace. This ensures that the binary is stored in the database with the Report Process record and will get backed up with the database.<br />
<br />
To try out the report:<br />
* Logout of System and into the client (e.g. GardenWorld Admin)<br />
* Select Invoice and find an invoice that will use the new report format<br />
* Click on the Print button (or Alt-P)<br />
* When the preview opens, click on ''Customize Report'' to open the Print Format Window<br />
* Find the field ''Jasper Report'' and use the dropdown to select the Report that you created above<br />
* Save the updated Print Format and reprint the document with the new report layout.<br />
<br />
==Filtering by records selected in iDempiere==<br />
<br />
When a report or process is started for multiple records selected in an iDempiere window, the selected record keys are stored in T_Selection. Each selection is associated with the current process instance through AD_PInstance_ID.<br />
<br />
The process instance ID is passed to JasperReports as the integer parameter AD_PINSTANCE_ID. Declare this parameter in the JRXML file:<br />
<br />
<parameter name="AD_PINSTANCE_ID" class="java.lang.Integer"/><br />
<br />
For tables with a numeric primary key, join the report query to T_Selection.T_Selection_ID:<br />
<br />
SELECT bp.*<br />
FROM C_BPartner bp<br />
INNER JOIN T_Selection sel<br />
ON sel.T_Selection_ID = bp.C_BPartner_ID<br />
AND sel.AD_PInstance_ID = $P{AD_PINSTANCE_ID}<br />
ORDER BY bp.Value<br />
<br />
Always restrict T_Selection by AD_PInstance_ID. Otherwise, the query could include selections belonging to other process executions.<br />
<br />
For tables using a UUID key, use T_Selection_UU instead:<br />
<br />
SELECT t.*<br />
FROM MyTable t<br />
INNER JOIN T_Selection sel<br />
ON sel.T_Selection_UU = t.MyTable_UU<br />
AND sel.AD_PInstance_ID = $P{AD_PINSTANCE_ID}<br />
<br />
T_Selection is normally populated when a collection of selected records is passed to the report. A report opened for one individual record normally receives the record through RECORD_ID instead.<br />
<br />
To support both a single record and multiple selected records, declare both parameters:<br />
<br />
<parameter name="RECORD_ID" class="java.lang.Integer"/><br />
<parameter name="AD_PINSTANCE_ID" class="java.lang.Integer"/><br />
<br />
The query can then use both selection mechanisms:<br />
<br />
SELECT bp.*<br />
FROM C_BPartner bp<br />
WHERE bp.C_BPartner_ID = $P{RECORD_ID}<br />
OR EXISTS (<br />
SELECT 1<br />
FROM T_Selection sel<br />
WHERE sel.AD_PInstance_ID = $P{AD_PINSTANCE_ID}<br />
AND sel.T_Selection_ID = bp.C_BPartner_ID<br />
)<br />
ORDER BY bp.Value<br />
<br />
This form supports reports started for a single record as well as reports started for multiple selected records.<br />
<br />
<br />
=References=<br />
* [[Creating reports using JasperReports]]<br />
* [https://www.youtube.com/watch?v=qupDLprUoJE Evenos video about JasperSoft Studio]<br />
* [https://community.jaspersoft.com/documentation/v640/tibco-jaspersoft-studio-user-guide JasperSoft Studio Guide]<br />
* [[Making fonts available to your JasperReports]]<br />
<br />
[[Category: JasperReports]]<br />
[[Category: Development|P]]<br />
[[Category: Developer documentation]]<br />
[[Category: Updated2022]]<br />
[[Category: How-To]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=NF14_Extensible_Report_Content_Generation&diff=23977NF14 Extensible Report Content Generation2026-08-16T11:12:24Z<p>Mbozem: Created page with "<div style="border:2px solid #d6a100; background:#fff8d8; padding:1em; margin-bottom:1em;"> '''Work in progress – not yet merged''' This feature is proposed for iDempiere 1..."</p>
<hr />
<div><div style="border:2px solid #d6a100; background:#fff8d8; padding:1em; margin-bottom:1em;"><br />
'''Work in progress – not yet merged'''<br />
<br />
This feature is proposed for iDempiere 14 but has '''not yet been merged into the master branch'''.<br />
<br />
As of 16 August 2026:<br />
<br />
* Jira status: '''Peer Review Queue'''<br />
* Pull request: '''Open'''<br />
* GitHub review decision: '''Changes requested'''<br />
* Merge status: '''Blocked'''<br />
<br />
The APIs and behavior described on this page may still change during review.<br />
Do not depend on them in production plug-ins until the pull request has been merged.<br />
</div><br />
<br />
IDEMPIERE-7070 introduces UI-independent and report-engine-independent extension points for generating and post-processing report content.<br />
<br />
The feature allows plug-ins to provide alternative report renderers and to enhance generated documents without depending on the ZK report viewer or modifying iDempiere core classes.<br />
<br />
== Purpose ==<br />
<br />
Before this change, the report extension mechanism was located in the ZK report viewer and exposed ZK- and Jasper-specific types.<br />
<br />
This caused several limitations:<br />
<br />
* The extension was not available to headless or server-side consumers.<br />
* Report-generation paths calling <code>ReportEngine</code> directly bypassed plug-in-provided output.<br />
* The mechanism was effectively tied to Jasper Reports.<br />
* Multiple independent document enhancements could not be combined cleanly because only one renderer could handle the request.<br />
* Preview and download names could expose the random suffix of an internal temporary Jasper file.<br />
<br />
A report may need several consecutive operations, for example:<br />
<br />
# Generate the initial PDF.<br />
# Add ZUGFeRD/Factur-X data.<br />
# Convert the document to PDF/A.<br />
# Add PDF attachments.<br />
# Add a watermark.<br />
# Digitally sign or encrypt the final document.<br />
<br />
IDEMPIERE-7070 separates initial report rendering from subsequent content processing, allowing these operations to be implemented by independent OSGi services and executed in a defined order.<br />
<br />
== Architecture ==<br />
<br />
Report content generation consists of two extension stages:<br />
<br />
<pre><br />
ReportContentRequest<br />
|<br />
v<br />
ranked IReportContentRendererFactory services<br />
|<br />
+-- first applicable renderer<br />
|<br />
+-- ReportEngine fallback<br />
|<br />
v<br />
initial report content<br />
|<br />
v<br />
all applicable IReportContentProcessor services<br />
in descending OSGi service-ranking order<br />
|<br />
v<br />
final processed content<br />
</pre><br />
<br />
=== Report content request ===<br />
<br />
<code>ReportContentRequest</code> is the common input for rendering and post-processing:<br />
<br />
<syntaxhighlight lang="java"><br />
public record ReportContentRequest(<br />
ReportEngine reportEngine,<br />
ProcessInfo processInfo,<br />
String title,<br />
boolean applyPostProcessing) {<br />
}<br />
</syntaxhighlight><br />
<br />
The three-argument constructor enables post-processing by default:<br />
<br />
<syntaxhighlight lang="java"><br />
ReportContentRequest request =<br />
new ReportContentRequest(reportEngine, processInfo, reportTitle);<br />
</syntaxhighlight><br />
<br />
Post-processing can be disabled explicitly when required:<br />
<br />
<syntaxhighlight lang="java"><br />
ReportContentRequest request =<br />
new ReportContentRequest(reportEngine, processInfo, reportTitle, false);<br />
</syntaxhighlight><br />
<br />
The report context preserves the relevant process information, including:<br />
<br />
* process parameters<br />
* record ID and record UUID<br />
* record selections<br />
* language<br />
* user and tenant context<br />
* transaction context<br />
* requested PDF filename<br />
<br />
=== Stage 1: report content rendering ===<br />
<br />
A plug-in can register an <code>IReportContentRendererFactory</code> OSGi service:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentRendererFactory {<br />
IReportContentRenderer createRenderer(ReportContentRequest request);<br />
}<br />
</syntaxhighlight><br />
<br />
Factories are evaluated in descending OSGi <code>service.ranking</code> order. A factory returns:<br />
<br />
* an <code>IReportContentRenderer</code> when it supports the request, or<br />
* <code>null</code> when it is not applicable.<br />
<br />
The first applicable renderer is selected.<br />
<br />
A renderer implements:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentRenderer {<br />
File getContent(String contentType, String fileExtension);<br />
<br />
ReportContentType[] getSupportedContentTypes();<br />
<br />
default int getRowCount() {<br />
return -1;<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Supported output types are described without any dependency on a UI toolkit:<br />
<br />
<syntaxhighlight lang="java"><br />
public record ReportContentType(<br />
String name,<br />
String fileExtension,<br />
String contentType) {<br />
}<br />
</syntaxhighlight><br />
<br />
An example Declarative Services registration is:<br />
<br />
<syntaxhighlight lang="java"><br />
@Component(<br />
service = IReportContentRendererFactory.class,<br />
immediate = true,<br />
property = "service.ranking:Integer=100"<br />
)<br />
public class CustomReportContentRendererFactory<br />
implements IReportContentRendererFactory {<br />
<br />
@Override<br />
public IReportContentRenderer createRenderer(<br />
ReportContentRequest request) {<br />
if (!supports(request))<br />
return null;<br />
<br />
return new CustomReportContentRenderer(request);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
The default Jasper renderer is supplied by the <code>org.adempiere.report.jasper</code> bundle with service ranking <code>0</code>. It is one provider of the generic API; the extension point is not limited to Jasper Reports.<br />
<br />
The Jasper renderer supports the existing report viewer formats, including:<br />
<br />
* PDF<br />
* HTML<br />
* CSV<br />
* XLS<br />
* XLSX<br />
* SSV<br />
<br />
If no registered factory handles the request, Core uses the standard <code>ReportEngine</code> as a fallback. The fallback supports PDF, HTML, CSV, XLS and XLSX.<br />
<br />
=== Stage 2: report content post-processing ===<br />
<br />
After rendering, the generated content is passed through every applicable <code>IReportContentProcessor</code> service:<br />
<br />
<syntaxhighlight lang="java"><br />
public interface IReportContentProcessor {<br />
<br />
boolean isApplicable(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension);<br />
<br />
File process(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File input);<br />
}<br />
</syntaxhighlight><br />
<br />
Processors are executed in descending OSGi <code>service.ranking</code> order. Each processor receives the result of the previous processor.<br />
<br />
A processor may:<br />
<br />
* modify the input file and return the same file, or<br />
* create and return a new file.<br />
<br />
It must not return <code>null</code>. A null result is treated as an error.<br />
<br />
Typical processor use cases include:<br />
<br />
* ZUGFeRD/Factur-X data<br />
* PDF/A conversion<br />
* PDF attachments<br />
* watermarks<br />
* digital signatures<br />
* encryption<br />
* other document transformations<br />
<br />
An example registration is:<br />
<br />
<syntaxhighlight lang="java"><br />
@Component(<br />
service = IReportContentProcessor.class,<br />
immediate = true,<br />
property = "service.ranking:Integer=100"<br />
)<br />
public class CustomPDFProcessor<br />
implements IReportContentProcessor {<br />
<br />
@Override<br />
public boolean isApplicable(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension) {<br />
return "application/pdf".equals(contentType)<br />
|| "pdf".equalsIgnoreCase(fileExtension);<br />
}<br />
<br />
@Override<br />
public File process(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File input) {<br />
// Modify input or create a new output file.<br />
return input;<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
The processor chain is applied both to custom renderer output and to content generated by the standard <code>ReportEngine</code> fallback.<br />
<br />
== Central Core API ==<br />
<br />
The common API is provided through <code>org.adempiere.base.Core</code>.<br />
<br />
The main entry points are:<br />
<br />
<syntaxhighlight lang="java"><br />
IReportContentRenderer getReportContentRenderer(<br />
ReportContentRequest request);<br />
<br />
File getReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension);<br />
<br />
File getReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File outputFile);<br />
<br />
File processReportContent(<br />
ReportContentRequest request,<br />
String contentType,<br />
String fileExtension,<br />
File content);<br />
</syntaxhighlight><br />
<br />
When an output file is supplied, only the final processed content is copied to that target. Intermediate renderer or processor files are not copied to it.<br />
<br />
Failures during report generation are propagated instead of silently returning an incomplete result.<br />
<br />
== Report-generation paths using the API ==<br />
<br />
The pull request routes the following report-generation paths through the common API:<br />
<br />
* ZK report preview and export<br />
* the legacy direct Jasper viewer<br />
* report email attachments<br />
* report archiving<br />
* workflow reports<br />
* server-side exports<br />
* document PDF generation<br />
* batch-print processes<br />
* payment and remittance printing<br />
* dunning and invoice printing<br />
* relevant ZK report and print processes<br />
<br />
Document generation for orders, invoices, shipments, distribution orders and RFQ responses is included in the affected server-side paths.<br />
<br />
The existing direct-printer path remains unchanged.<br />
<br />
== Report viewer behavior ==<br />
<br />
The ZK report viewer uses the common content renderer and processor chain.<br />
<br />
Processed content is cached for each combination of MIME type and file extension. Preview, export, email and archive actions can therefore reuse the same final result.<br />
<br />
This is important for processors such as:<br />
<br />
* document signing<br />
* attachment generation<br />
* ZUGFeRD/Factur-X generation<br />
* PDF/A conversion<br />
<br />
Without caching, such processors could be executed more than once for the same viewer output.<br />
<br />
The report viewer also:<br />
<br />
* shows only formats supported by the active renderer or report engine;<br />
* preserves the original <code>ProcessInfo</code>;<br />
* preserves record UUIDs;<br />
* refreshes native print data after changing the print format;<br />
* uses the logical report name for preview and download media;<br />
* retains unique filenames for internal temporary files.<br />
<br />
Consequently, users no longer see the random suffix generated for an internal Jasper temporary file in the preview or download filename.<br />
<br />
== Compatibility ==<br />
<br />
* Existing Jasper reports are handled by the default renderer in the Jasper bundle.<br />
* The API is not limited to Jasper Reports.<br />
* Other report engines can register their own renderer factory.<br />
* Requests without a matching renderer fall back to <code>ReportEngine</code>.<br />
* Installations without an <code>IReportContentProcessor</code> receive the original generated content unchanged.<br />
* Headless installations can use the renderer and processor APIs without the ZK bundle.<br />
* Existing report viewer export formats are retained.<br />
* Legacy <code>ZkJRViewer</code> adapters are retained.<br />
* Direct-printer behavior is unchanged.<br />
* No database migration is required.<br />
<br />
== Example use cases ==<br />
<br />
=== ZUGFeRD/Factur-X ===<br />
<br />
A processor can embed ZUGFeRD/Factur-X XML into a PDF produced by any renderer.<br />
<br />
This integrates electronic invoice generation into the normal workflow:<br />
<br />
<pre><br />
Print button<br />
-> Preview<br />
-> E-mail<br />
-> Archive<br />
</pre><br />
<br />
The same processor can be applied to a PDF produced by:<br />
<br />
* the native report engine<br />
* Jasper Reports<br />
* a FreeMarker-based renderer<br />
* another custom report engine<br />
<br />
This complements the existing [[Plugin:_ZUGFeRDXInvoice|ZUGFeRD/XInvoice plug-in]] by allowing its result to participate in the standard report workflow.<br />
<br />
=== PDF attachments ===<br />
<br />
A processor can attach additional PDF documents to the generated report. For example, a drawing attached to an order can be included in the final order PDF.<br />
<br />
=== Alternative report engines ===<br />
<br />
The API was tested conceptually and practically with a FreeMarker-based print-template engine. Such a plug-in can examine the print format in <code>ReportContentRequest</code>, return its own renderer and use the same post-processing pipeline as Jasper or the native report engine.<br />
<br />
== Validation ==<br />
<br />
=== Automated validation ===<br />
<br />
The pull request contains integration coverage for:<br />
<br />
* renderer selection by OSGi service ranking<br />
* fallback to the next renderer factory<br />
* fallback to the standard report engine<br />
* default Jasper renderer registration<br />
* supported output formats<br />
* processor ordering<br />
* processor applicability<br />
* invalid null processor results<br />
* enabling and disabling post-processing<br />
* processed-content caching<br />
* propagation of report-generation failures<br />
<br />
After fixes made during review, the reported validation results were:<br />
<br />
* <code>ServerReportCtlTest</code>: 1 test, 0 failures, 0 errors<br />
* <code>ReportViewerContentRendererFactoryTest</code>: 9 tests, 0 failures, 0 errors<br />
* complete 63-module Maven <code>verify</code> reactor: '''BUILD SUCCESS'''<br />
* <code>git diff --check</code>: passed<br />
<br />
Earlier failures concerning the requested PDF filename and missing server-side print data were fixed before the successful final validation.<br />
<br />
=== Integration testing ===<br />
<br />
The reported integration-test environment was:<br />
<br />
{| class="wikitable"<br />
! Component<br />
! Value<br />
|-<br />
| iDempiere<br />
| Version 14 development workspace<br />
|-<br />
| Java<br />
| OpenJDK 17.0.19<br />
|-<br />
| Runtime<br />
| Eclipse PDE<br />
|-<br />
| Database<br />
| PostgreSQL<br />
|-<br />
| Database migration level<br />
| <code>202607261257_IDEMPIERE-6552.sql</code><br />
|-<br />
| ZK<br />
| 10.3.0.1<br />
|-<br />
| Locale<br />
| <code>de_DE</code><br />
|}<br />
<br />
The integration test used:<br />
<br />
* a FreeMarker report renderer;<br />
* a ZUGFeRD/Factur-X content processor;<br />
* invoice <code>C_Invoice_ID=103</code>.<br />
<br />
The following flow was tested:<br />
<br />
# Generate an invoice using the normal Print button.<br />
# Render the invoice through the new report content pipeline.<br />
# Post-process the generated PDF through <code>IReportContentProcessor</code>.<br />
# Embed Factur-X/ZUGFeRD XML into the PDF.<br />
# Combine the FreeMarker renderer with the ZUGFeRD processor.<br />
<br />
Reported result:<br />
<br />
* <code>Invoice_Header.pdf</code> was generated successfully.<br />
* The PDF contained an embedded <code>factur-x.xml</code> attachment.<br />
* The embedded XML was 9,711 bytes and began with a valid <code>CrossIndustryInvoice</code> document.<br />
* The ZUGFeRD processor worked independently of the selected renderer.<br />
* No remaining ZUGFeRD, PostgreSQL or PDFBox errors were reported in the server log after the final test.<br />
<br />
Further review and broader testing of the affected report-generation paths and representative processor combinations are still recommended before merge.<br />
<br />
== Known limitation ==<br />
<br />
Multi-record Jasper report handling is intentionally outside the scope of this change and is tracked separately in [https://idempiere.atlassian.net/browse/IDEMPIERE-7073 IDEMPIERE-7073].<br />
<br />
== Related work and examples ==<br />
<br />
* [https://idempiere.atlassian.net/browse/IDEMPIERE-7070 IDEMPIERE-7070 – Make report content generation extensible through OSGi]<br />
* [https://github.com/idempiere/idempiere/pull/3318 Pull request #3318]<br />
* [https://idempiere.atlassian.net/browse/IDEMPIERE-6069 IDEMPIERE-6069 – related composable report-processing requirement]<br />
* [[Plugin:_ZUGFeRDXInvoice|ZUGFeRD/XInvoice plug-in]]<br />
* [https://github.com/mbozem/idempiere-print-template/tree/IDEMPIERE-7070 FreeMarker renderer integration branch]<br />
* [https://github.com/mbozem/auler.gmbh.zugferdxinvoice/tree/agent/idempiere-14-compatibility ZUGFeRD/Factur-X integration branch]<br />
<br />
== Tracking information ==<br />
<br />
{| class="wikitable"<br />
! Item<br />
! Value<br />
|-<br />
| Jira issue<br />
| [https://idempiere.atlassian.net/browse/IDEMPIERE-7070 IDEMPIERE-7070]<br />
|-<br />
| Issue type<br />
| Improvement<br />
|-<br />
| Priority<br />
| Minor<br />
|-<br />
| Jira status<br />
| Peer Review Queue<br />
|-<br />
| Reporter / assignee<br />
| Markus Bozem<br />
|-<br />
| Created<br />
| 29 July 2026<br />
|-<br />
| Pull request<br />
| [https://github.com/idempiere/idempiere/pull/3318 #3318]<br />
|-<br />
| Pull request target<br />
| <code>master</code><br />
|-<br />
| Pull request status<br />
| Open — not merged<br />
|-<br />
| Pull request scope as of 16 August 2026<br />
| 37 changed files, 1,526 additions and 495 deletions<br />
|}<br />
<br />
[[Category:New Features]]<br />
[[Category:New Features w14]]<br />
[[Category:New Features Development]]<br />
[[Category:New Features Technical]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=Category:New_Features_w13&diff=23976Category:New Features w132026-08-16T10:50:24Z<p>Mbozem: </p>
<hr />
<div>== Features in version 13 Orion ==<br />
<br />
* [[:Category:New Features Architecture|'''A''' → Architecture]]<br />
* [[:Category:New Features Development|'''D''' → Development]]<br />
* [[:Category:New Features Functional|'''F''' → Functional]]<br />
* [[:Category:New Features Security|'''S''' → Security]]<br />
* [[:Category:New Features Technical|'''T''' → Technical]]<br />
* [[:Category:New Features User Experience (Usability)|'''U''' → User Experience (Usability)]]<br />
<br />
[[Category:New Features]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=Category:New_Features_w14&diff=23975Category:New Features w142026-08-16T10:49:56Z<p>Mbozem: Created page with "== Features arriving in version 14 Dev Build == NOTE: Version 14 is still unreleased - it is available in the default branch of the source code repository and it can be teste..."</p>
<hr />
<div>== Features arriving in version 14 Dev Build ==<br />
<br />
NOTE: Version 14 is still unreleased - it is available in the default branch of the source code repository and it can be tested in https://test.idempiere.org and https://test-oracle.idempiere.org<br />
<br />
<br />
* [[:Category:New Features Architecture|'''A''' → Architecture]]<br />
* [[:Category:New Features Development|'''D''' → Development]]<br />
* [[:Category:New Features Functional|'''F''' → Functional]]<br />
* [[:Category:New Features Security|'''S''' → Security]]<br />
* [[:Category:New Features Technical|'''T''' → Technical]]<br />
* [[:Category:New Features User Experience (Usability)|'''U''' → User Experience (Usability)]]<br />
<br />
[[Category:New Features]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=Setting_up_Eclipse&diff=15574Setting up Eclipse2019-09-09T07:07:42Z<p>Mbozem: </p>
<hr />
<div><!-- breadcrumb --><br />
<font size=-2><br />
&lArr;<br />
[[Installing_iDempiere|Table of Contents]] |<br />
[[Download the Code]] |<br />
Setting up Eclipse |<br />
[[Importing DB Seed Manually]]<br />
&rArr;<br />
</font><br />
<br />
== Materialize and build ==<br />
<br />
On the operating system navigate to the folder where you cloned the code, named above as $IDEMPIERE_REPOSITORY, f.e. /home/carlos/sources/myexperiment), and run the next command:<br />
cd $HOME/sources/myexperiment<br />
mvn verify -U<br />
This command download all libraries on Bundle-ClassPath, build all projects and output binaries to org.idempiere.p2/target/products<br />
<br />
== Import projects in Eclipse ==<br />
<br />
* Open again the eclipse you configured with the workspace pointing to the folder where you cloned the code<br />
* Turn off Project > Build automatically<br />
* Navigate to File > Import<br />
* Navigate to Maven > Existing Maven Projects<br />
* Click Next button and Browse to $IDEMPIERE_REPOSITORY (must appear there by default)<br />
* All projects must appear selected, click Finish to complete the import<br />
* At the end all projects are loaded into workspace<br />
<br />
== Workspace settings ==<br />
<br />
* In eclipse, navigate to Window > Preferences > General > Workspace<br />
* set "Text file encoding" to "UTF-8" (if default is different)<br />
* set "New text file line delimiter" to "Unix" (if default is different)<br />
* navigate to Window > Preferences > Java > Compiler<br />
* set Java > Compiler > Compiler compliance level to "11"<br />
<br />
== Set target platform ==<br />
<br />
* Still in eclipse<br />
* Navigate to File > Import<br />
* Navigate to General > Existing Projects into Workspace<br />
* Click Next button and Browse to $IDEMPIERE_REPOSITORY/org.idempiere.p2.targetplatform<br />
* Click Finish to complete the import<br />
<br />
* Now open the file org.idempiere.p2.targetplatform.target within the project just imported org.idempiere.p2.targetplatform<br />
** This is the default target platform definition with remote url<br />
** Here eclipse takes some time downloading the required dependencies, you can prepare some Colombian coffee and wait patiently :)<br />
* At Target Editor, click the "Set as Active Target Platform" link<br />
* Wait for Eclipse to finish downloading bundles onto target platform<br />
** Click the "Reload" button if some download fail, until there are not red errors on the Locations list<br />
<br />
* At the end you can enabled back Project > Build automatically<br />
* Restart eclipse in order to do a clean build<br />
<br />
<br />
''This tutorial is brought to you by [[User:CarlosRuiz|Carlos Ruiz]] from [http://globalqss.com GlobalQSS]. Feel free to improve directly or suggest using the Discussion tab.<br />
<br />
<br />
<br />
[[Category:User Manual|I]]<br />
[[Category:Installation|E]] <br />
[[Category:Installation Eclipse]] <br />
[[Category:Development]]<br />
[[Category:Developer documentation]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=Importing_DB_Seed_Manually&diff=11269Importing DB Seed Manually2017-01-02T11:48:20Z<p>Mbozem: Added link to modified script to apply patches from directory</p>
<hr />
<div><!-- breadcrumb --><br />
<font size=-2><br />
&lArr;<br />
[[Installing_iDempiere|Table of Contents]] |<br />
[[Setting up Eclipse]] |<br />
Importing DB Seed Manually |<br />
[[Running iDempiere within Eclipse]]<br />
&rArr;<br />
</font><br />
<br />
Please note this procedure is intended for technical people wanting to configure iDempiere to run in Eclipse, there is an easier mechanism on the installers to create the database.<br />
<br />
Let's check the steps to create an idempiere postgres database:<br />
<br />
== Create adempiere user ==<br />
<br />
sudo su - postgres<br />
psql -U postgres -c "CREATE ROLE adempiere SUPERUSER LOGIN PASSWORD 'adempiere'"<br />
logout<br />
<br />
'''WARNING:''' Of course this is an insecure password, it is recommended that you set up a proper password for this user account<br />
<br />
== Create the idempiere database ==<br />
<br />
createdb --template=template0 -E UNICODE -O adempiere -U adempiere idempiere<br />
psql -d idempiere -U adempiere -c "ALTER ROLE adempiere SET search_path TO adempiere, pg_catalog"<br />
<br />
When asked the password please provide the adempiere password that you set up in the previous step.<br />
<br />
'''NOTE:''' It is possible that you will confront problems related to pg_hba.conf configuration (/etc/postgresql/{version}/main/pg_hba.conf), it's beyond the scope of this tutorial to solve those problems at this moment, please check and configure proper permissions. Also, this tutorial is intended to work on a postgres installed locally, if your postgres is elsewhere you must use corresponding -h (host) and -p (port) parameters for createdb and psql. If you receive the error '''createdb: could not connect to database template1: FATAL: Peer authentication failed for user "adempiere"''' you might be able to add '''-h localhost''' to resolve quickly. For a more permanent solution visit [http://stackoverflow.com/questions/18664074/getting-error-peer-authentication-failed-for-user-postgres-when-trying-to-ge stackoverflow].<br />
<br />
== Installing UUID (required to apply some migration scripts) ==<br />
<br />
Some migration scripts references the function generate_uuid, unfortunately the way to install this is different on different postgres versions, so we were not able to include it by default on the DB seed, next are the instructions per version:<br />
<br />
* Remember from the prerequisites you must have installed postgresql-contrib to make the generate_uuid function to work<br />
<br />
=== For postgresql versions 8.X, 9.0 ===<br />
<br />
* Run via psql the script provided at db/ddlutils/postgresql/uuid-ossp.sql<br />
** psql -d idempiere -U adempiere -f db/ddlutils/postgresql/uuid-ossp.sql<br />
<br />
=== For postgresql 9.1 and above ===<br />
<br />
* Run the command CREATE EXTENSION "uuid-ossp" using psql<br />
** psql -d idempiere -U adempiere -c 'CREATE EXTENSION "uuid-ossp"'<br />
<br />
== Import the seed ==<br />
<br />
== PostgreSQL 8.4 or 9.0 ==<br />
<br />
This tutorial uses postgres 8.4 - please note the following instructions are applicable if you use postgresql 8.4 or 9.0, for 9.1 or higher see below.<br />
<br />
cd /tmp<br />
jar xvf $IDEMPIERE_REPOSITORY/org.adempiere.server-feature/data/seed/Adempiere_pg84.jar<br />
psql -d idempiere -U adempiere -f Adempiere_pg84.dmp<br />
<br />
You must replace $IDEMPIERE_REPOSITORY with the folder of your cloned repository.<br />
<br />
== PostgreSQL 9.1 or higher ==<br />
<br />
cd /tmp<br />
jar xvf $IDEMPIERE_REPOSITORY/org.adempiere.server-feature/data/seed/Adempiere_pg.jar<br />
psql -d idempiere -U adempiere -f Adempiere_pg.dmp<br />
<br />
== Applying additional migration scripts ==<br />
<br />
See also [http://wiki.idempiere.org/en/Upgrade_from_1.0c_to_2.0#Periodic_upgrade_within_same_version Periodic upgrade within same version]<br />
<br />
=== Manual way ===<br />
<br />
Now, you must check if there are new migration scripts after the last applied, you can check the migration scripts this way:<br />
<br />
ls $IDEMPIERE_REPOSITORY/migration/i1.0c-release/postgresql<br />
<br />
And compare the list of migration scripts with the contents of your AD_MigrationScript table, execute this in postgres:<br />
<br />
select name from ad_migrationscript order by 1<br />
<br />
Please note that you must do this check every time you upgrade your version.<br />
<br />
If you find there are unapplied migration scripts then you can apply them with:<br />
<br />
psql -d idempiere -U adempiere -f $IDEMPIERE_REPOSITORY/migration/i1.0c-release/postgresql/20130627011956_ProbableFutureMigrationScript.sql<br />
<br />
Please check carefully the output of the migration scripts, if you find errors please ask for help on the [http://groups.google.com/group/idempiere support forums]<br />
<br />
You must repeat the previous for each unapplied migration scripts, it's recommended also to take note of the last applied for future reference.<br />
<br />
At the end you can run the post-migration processes like this:<br />
<br />
cat $IDEMPIERE_REPOSITORY/migration/processes_post_migration/postgresql/*.sql | psql -d idempiere -U adempiere<br />
<br />
=== Automated way (linux) ===<br />
<br />
There are two scripts contributed that help with this task:<br />
<br />
* [http://bitbucket.org/CarlosRuiz_globalqss/idempiere-stuff/raw/tip/script_to_sync_db/syncApplied.sh syncApplied.sh for PostgreSQL] or [http://markus-bozem.de/?p=1 modified syncApplied.sh for PostgreSQL] <br />
* [http://bitbucket.org/CarlosRuiz_globalqss/idempiere-stuff/raw/tip/script_to_sync_db/syncApplied_ora.sh syncApplied_ora.sh for Oracle]<br />
<br />
You can download the corresponding file, edit the variables on top to fit your configuration and then you can run periodically the script every time you update source code.<br />
<br />
''This tutorial is brought to you by [[User:CarlosRuiz|Carlos Ruiz]] from [http://globalqss.com GlobalQSS]. Feel free to improve directly or suggest using the Discussion tab.<br />
<br />
[[Category:User Manual|I]]<br />
[[Category:Installation|E]] <br />
[[Category:Installation Eclipse]] <br />
[[Category:Development]]<br />
[[Category:Developer documentation]]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=User:Mbozem&diff=8690User:Mbozem2015-09-07T15:04:41Z<p>Mbozem: /* Kontaktdaten */</p>
<hr />
<div>== Kontaktdaten ==<br />
<br />
Markus Bozem<br />
<br />
Geschwister-Scholl-Platz 3<br />
<br />
63741 Aschaffenburg<br />
<br />
[mailto:mbozem@bozem.de Email]<br />
[http://www.markus-bozem.de Homepage]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=User:Mbozem&diff=8689User:Mbozem2015-09-07T15:03:35Z<p>Mbozem: </p>
<hr />
<div>== Kontaktdaten ==<br />
<br />
Markus Bozem<br />
Geschwister-Scholl-Platz 3<br />
63741 Aschaffenburg<br />
<br />
[mailto:mbozem@bozem.de Email]<br />
[http://www.markus-bozem.de Homepage]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=User:Mbozem&diff=8688User:Mbozem2015-09-07T15:01:57Z<p>Mbozem: </p>
<hr />
<div>Homepage<br />
<br />
[http://www.markus-bozem.de Homepage]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=User:Mbozem&diff=8687User:Mbozem2015-09-07T15:01:34Z<p>Mbozem: Created page with "Homepage [http://www.markus-bozem.de]"</p>
<hr />
<div>Homepage<br />
<br />
[http://www.markus-bozem.de]</div>Mbozemhttps://wiki.idempiere.org/w-en/index.php?title=IDempiere_World_Conference_2015&diff=8596IDempiere World Conference 20152015-08-31T12:08:15Z<p>Mbozem: /* Attending Conference */</p>
<hr />
<div>=Time=<br />
<br />
* September 3/4 (thursday/friday)<br />
* best practices for community plugins<br />
<br />
* Paid Developer [[iDempiere workshop 2015|Workshop]] next week after the conference at the Bischofstein Castle near Koblenz (september 7-11)<br />
<br />
=Venue=<br />
<br />
The conference is in [http://en.wikipedia.org/wiki/Krefeld Krefeld], Germany. As the location I booked the same room where we held the successful [http://wiki.idempiere.org/en/IDempiere_World_Conference_2013 IDempiere World Conference 2013], [http://diekulisse.eu/ Die Kulisse].<br />
<br />
"Die Kulisse" is a big, nice restaurant that lies in opposite to the back entrance of the main train station of Krefeld. You can reach it easily per Train (Krefeld Hbf), per S-Bahn (City-Train) from Düsseldorf/Düsseldorf Airport (U76) or use the big parking site behind the "Fabrik Heeder" Theater.<br />
<br />
The workshop is 170 kilometers away from Krefeld near Hatzenport (a small village near [https://en.wikipedia.org/wiki/Koblenz Koblenz]) in the the[https://en.wikipedia.org/wiki/Bischofstein_Castle_(Germany) Bischofstein Castle]. That is in the Moselle Valley which is one of the most lovely landscapes in germany (and not far away from the [https://en.wikipedia.org/wiki/Deutsches_Eck Deutsches Eck] and the [https://en.wikipedia.org/wiki/Middle_Rhine Middle Rhine Valley]). This location allows at the same time to relax and to focus on our software. Most of us will sleep at the castle and be together for the evening to become acquainted with each other and share more knowledge and stories.<br />
<br />
The castle is normally used as a youth hostel. You can see some of the rooms [http://www.gruppenhaus.de/burg-bischofstein-hatzenport-hs2843.html here].<br />
<br />
= Planned talks =<br />
<br />
There are 11 hours of talks and discussions during both conference days. We have a call for papers here: https://groups.google.com/forum/#!topic/idempiere/l0wQxo-EUx8<br />
<br />
[[File:Tentative_schedule.png]]<br />
<br />
= Attending Conference=<br />
# [[User:TBayen|Thomas Bayen]], BX Service GmbH & Jakob Bayen KG, Germany<br />
# [[User:CarlosRuiz|Carlos Ruiz]], Colombia<br />
# [[User:Hriess|Hans Riess]], Germany<br />
# [[Usuario:luisamesty|Luis Amesty]], Venezuela, España<br />
# [[User:Chuckboecking|Chuck Boecking]], Austin, TX, United States<br />
# [[User:HenrietteBaumann|Henriette Baumann]], Switzerland<br />
# [[User:gabrielfranh|Gabriel F. Habermann]], devCoffee, Brazil<br />
# [[User:muriloht|Murilo H. Torquato]], devCoffee, Brazil<br />
# [[User:smartjsp|Pedro Rozo]], SmartJSP, Colombia<br />
# [[User:Nbe222|Norbert Bede]], MULTIMAGE, Slovakia<br />
# Philippe Baumann, Switzerland<br />
# [[User:Diego.ruiz|Diego Ruiz]], Bx Service GmbH, Germany, Colombia<br />
# [[User:Pshepetko|Peter Shepetko]], Ukraine<br />
# [[User:a42niem|Dirk Niemeyer]], Germany<br />
# [[User:a42jannis|Jannis Edzards]], Germany<br />
# [[User:Eugene Barg|Eugene Barg]], Russia<br />
# [[User:afildan|Anton Fildan]], Austria<br />
# [[User:Dpansheriya|Deepak Pansheriya]], India<br />
# [[User:dantam|Daniel Tamm]], Sweden<br />
# [[User:spok|Sergey Polyarus]], Blue Water Parts, France<br />
# [[User:Aranvier|Alain Ranvier]], Blue Water Parts, France<br />
# Hervé Bernard, Positiv Buildings (Pool Repair Center), France<br />
# Ignacio Soriano, Capristo Automotive, Germany<br />
# Longo Marco, Italy<br />
# Tomáš Švikruha, MULTIMAGE, Slovakia<br />
# Raouf Mazouz, France<br />
# [[User:Hideaki_Hagiwara|Hideaki Hagiwara]] , Japan<br />
# Peter Springborn, Berlin, Germany<br />
# [[User:Nilskm|Nils Kohlström]], Sweden<br />
# Shaun Melville - South Africa<br />
# Honoré Tiako – Germany<br />
# Mirko Trinajstić - BX Service GmbH, Germany<br />
# Steven Sackett - Adaxa, Australia<br />
# Lukas Nosalek, Czech Republic<br />
# Michal Žilinčár, Zitec s.r.o., Slovakia<br />
# Ladislav Nagy, Bigware, Slovakia<br />
# [[User:isener|Ismet Sener]], Apeldoorn, Netherlands<br />
# [[User:mbozem|Markus Bozem]], Aschaffenburg, Germany<br />
<br />
** please add your name here if you plan to attend<br />
<br />
=Accommodation=<br />
<br />
Krefeld is about 20 km from the District Capital and fair location Düsseldorf (International Airport DUS), about 50km away from Cologne and 20km to the Netherland border. It is well equiped with Hotels of different categories. Ask me (Thomas Bayen) for help, I know many hotels through my business. Or just have a look at this list:<br />
<br />
The conference location is direct to the Krefeld Hauptbahnhof (Main Train Station). Next to it is the Ibis Hotel, which has small and cheap rooms:<br />
* http://www.accorhotels.com/de/hotel-3083-ibis-budget-krefeld-messe-duesseldorf/index.shtml<br />
<br />
* if you like it small and beautiful<br />
** http://www.cafe-saint-denis.de/<br />
** http://www.montenegrokrefeld.de/<br />
* If you like unpersonal but big franchise hotels...<br />
** http://www.accorhotels.com/de/hotel-5404-mercure-parkhotel-krefelder-hof/index.shtml<br />
** http://www.accorhotels.com/de/hotel-5402-mercure-tagungs-landhotel-krefeld/index.shtml<br />
<br />
The workshop/software training is not in Krefeld but about 170 km away at the Bischofstein Castle. Please contact Thomas Bayen for accomodation there. Most of us will sleep at the castle and be together for the evening to become acquainted with each other and share more knowledge and stories.<br />
<br />
The castle is normally used as a youth hostel. You can see some of the rooms [http://www.gruppenhaus.de/burg-bischofstein-hatzenport-hs2843.html here]. As an alternative we can help you book a bed in a nearby hotel (for example [http://www.winzerhof-gietzen.com/ Winzerhof Gietzen]).<br />
<br />
=Presenters=<br />
* [[User:CarlosRuiz|Carlos Ruiz]]<br />
* [[User:Diego.ruiz|Diego Ruiz]]<br />
* [[User:Chuckboecking|Chuck Boecking]]<br />
* [[User:TBayen|Thomas Bayen]]<br />
* Steven Sackett<br />
* [[User:Dpansheriya|Deepak Pansheriya]]<br />
* Pedro Rozo<br />
* [[User:muriloht|Murilo H. Torquato]]<br />
* [[User:Hriess|Hans Riess]]<br />
* [[User:a42niem|Dirk Niemeyer]]<br />
* [[User:Nbe222|Norbert Bede]]<br />
<br />
<br />
** please contact coordination team if you have interesting applications, plugins, visions and/or plans to present<br />
<br />
= Social Events =<br />
<br />
For the evening there is a big Dinner together with all conference participants. That will be in the same location as the conference (or outside if weather allows that).<br />
<br />
There may be some social events for the weekend. When you come a long way to visit germany you might be interested to spend the weekend together with other community members. It may be we visit the [https://en.wikipedia.org/wiki/Altstadt_(D%C3%BCsseldorf) Düsseldorf Altstadt] or we repeat the famous community visit in the [http://jazzkeller.info/ Jazzkeller Krefeld]. These events are private organized and you are free to join. As this is of most interest for the workshop participants see [[iDempiere workshop 2015]] and/or ask Thomas Bayen about that.<br />
<br />
= Developer Workshop Plan =<br />
<br />
See [[iDempiere workshop 2015|Workshop]] for more information about the workshop agenda.<br />
<br />
<br />
= Costs =<br />
<br />
The '''fee for the conference''' is 30 € for each day and 30 € for the evening event, that are all together '''90,- €''' for the conference.<br />
<br />
The '''weekend events''' are private organized. You can join us '''for free'''. It might be there is some entrance fee or beer to pay. ;-)<br />
<br />
The '''user workshop''' and the '''developer workshop with Carlos Ruiz''' costs '''1.000,- € per five days''' per person. Shorter bookings may be possible - depending on your interest. Please ask Carlos Ruiz or Thomas Bayen.<br />
<br />
=Coordination Team=<br />
* [[User:Diego.ruiz|Diego Ruiz]]<br />
* [[User:TBayen|Thomas Bayen]]<br />
* [[User:CarlosRuiz|Carlos Ruiz]]<br />
<br />
=Evening and weekend events=<br />
<br />
Events will be fixed if enough people are on the list. We have some possibilities like:<br />
* visit in the [http://de.wikipedia.org/wiki/Burg_Linn Linn Castle] and its surrounding park<br />
* Krefeld has a [http://de.wikipedia.org/wiki/Flugplatz_Krefeld-Egelsberg Airport] for Gliders/Sailplanes. If weather is good we could arrange some flights<br />
* We have a germany-wide famous location for Jazz music, the [http://www.jazzkeller.info/ Jazz-Cellar]<br />
* real linuxers will like the [http://portal.krefeld-pinguine.de/ Krefeld Penguins] or the [http://www.krefelderzoo.com/bereiche/zoofreunde-ev/pinguinart.html Penguins in Krefeld] :-)<br />
* [http://www.kulturfabrik-krefeld.de/ Party]<br />
* [http://www.theater-kr-mg.de/ Culture]<br />
* see here for more info: [[iDempiere workshop 2015|Workshop]]<br />
<br />
=Previous conferences=<br />
* [[IDempiere_World_Conference_2013]]<br />
* [[IDempiere_Workshop_2014]]<br />
<br />
<br />
<br />
[[Category:Community|M]]<br />
[[Category:Meetings|5]]<br />
[[Category:Meetings 2015]]<br />
<br />
<br />
<br />
[[en:IDempiere World Conference 2015]]<br />
[[de:Weltkonferenz 2015]]</div>Mbozem