| Table of Contents |
|---|
Overview
YC provides a flexible mechanism to create report plugins that will naturally fit into existing report wizard interface, thus system integrator only need to concentrate on the business functionality around generating specific report.
...
- ReportDescriptor - which defines the report unique ID and parameters that is requires/allows
- ReportWorker - which allows to provide options for "select" style parameters and generates the the data for the report
- ReportGenerator - which converts data object created by ReportWorker into a report file
Extension points
By default most of the reports would be configured for the Admin app to provide business users with various statistical and accounting data. All out of the box report definitions are specified in Spring context file manager-report.xml. For customisations it is advisable to create your own maven module that would have core-module-reports as a dependency and would specify adm-servlet-ext.xml to naturally be included in the application.
...
Delivery report, learn by example
Delivery report represents a PDF invoice that can be generated for any given order. We will look into the particulars of the report configuration, which should give an idea of how the whole report framework works both in Admin app and the storefront.
Admin app
Custom
...
implementationLabel Body 3.6.0 Colour danger
| Body | 3.6.0 |
|---|---|
| Colour | danger |
| Info |
|---|
| This is old style method which is not recommended anymore. It does however show some concepts of reporting framework which are useful. The user is advised to use extension point (see next section) to create custom report implementations and inject additional custom reports. |
...
| Tip |
|---|
| For generating alternative report files (e.g. CSV, Image charts) you need to override the reportGenerator bean and provide a composite ReportGeneratorimplementation that can switch between the different report generator implementation depending on the report descriptor configurations. |
Reports via
...
extensionLabel Body 3.7.0+
| Body | 3.7.0+ |
|---|
Reports framework has been simplified in version 3.7.0 to fully use extensions capability..
...
Out of the doc the platform now support two kinds of generator plug-ins: PDF and Excel report generators.
Storefront
Normally storefront would not need custom reports. However there are some cases when a report file needs to be generated. Such as the case with delivery report that can be used for providing customers with downloadable PDF invoice files for the orders they have placed.
...