Report
⇐ Table of Contents{{#if: Functionality| | Functionality }}{{#if: | | [[{{{3}}}]] }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | Report{{#if: Request| | Request }} ⇒
The Report function provides a way to generate simple reports based on the data being viewed.
Access
Icon: | |
Menu: | →Report }}{{#if: | → }}{{#if: | → }} |
Short Cut: | <F11> |
Restrictions
To enable reports, the user's role must have Can Report checked in the {{#if: |{{{2}}}|Role }} Window.
To Export the reports, the user's role must have Can Export checked in the {{#if: |{{{2}}}|Role }} Window.
The Report function is only available when viewing a data window.
Description
The Report function will display reports on the current records and table. The format of the report is determined by Print Formats, several of which can be defined for any table.
It is possible to modify the report formats and add others so that there is a choice of what you want to see when you click the report button. For more information on the possibilities, see Print Formats.
It is also possible to override the internal report mechanism and create the reports with Jasper Reports. See Jasper Reports Integration for more information.
When the report menu or icon () is selected or clicked, ADempiere will check to see if there are any predefined reports.
If there are no pre-defined reports, ADempiere will create one using the name of the table. This default print format will use a standard header and will display all available fields in a flat format, one line per row. This will often result in a report that is many pages wide - not very useful, but its a start.
If only one report is defined, it will be displayed immediately. If there are more than one, a small pop-up dialog will appear next to the Report icon in the tool bar, as shown below, with a list of all the defined reports. Clicking on one of the items in the list will open the selected report.
ADempiere will determine if the report is a Jasper Report or a standard report and will display the report accordingly. For more on Jasper Reports, see the Jasper Report documentation. The rest of this article refers to the standard report.
The Report Viewer appears as shown below.
The Viewer has the following main components:
- a title bar
- a main menu (File, View, Go, ...)
- a tool bar with several controls
- the report window
- a status bar at the bottom and
- a page count
The title bar and main menu are pretty standard with the following additions:
- File
- Customize Report
- Translate
- Lookup Record
- Go
- First Page
- Previous Page
- Next Page
- Last Page
The tool bar contains the following controls:
- Previous Page
- Go To Page
- Next Page
- Zoom
- Drill (by table)
- Print Formats
- Summary check box
- Customize Report or Page Setup
- Lookup Record
- Print Preview
- Send mail
- Archive documents
- Export
- Exit the Window
For Developers
The software that controls this dialog is found in
- base/src
- org.compiere.print.ReportEngine.java
- client/src
- org.compiere.apps.APanel.java
- org.compiere.print.AReport.java
- org.compiere.print.ReportCtl.java
- org.compiere.print.ReportViewerProvider.java
- org.compiere.print.SwingViewerProvider.java
- org.compiere.print.Viewer.java