Reports
The application comes with Jasper reports engine. This helps administrators create their own reports.
The JasperReports Library is one of the world's most popular reporting engines. It can use data from any type of data source and produce pixel-perfect documents that can be viewed, printed, or exported in a variety of document formats including HTML, PDF, Excel, LibreOffice and Word.
More information on how to build your own reports is available at Creating your own reports.
More information about the Jasper report engine version included with the application is available at Application version compatibility table.
Keep in mind that any font used in the reports should be installed on the OpenKM server. For example, if you are using Arial (the sample provided reports use this font), you should ensure the Arial font is installed. For example, if you are using Ubuntu the package to install is ttf-mscorefonts-installer.
$ apt-get install ttf-mscorefonts-installer
In Red Hat or CentOS, the package is msttcore-fonts. You need to restart the server after this package is installed.
If you are not sure which fonts are available, execute this scripting code from Administration:
import java.awt.*;
for (String font : GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames()) {
print("Font: " + font);
}
Reports are shown in a table structure.
Name |
File name |
Active |
Create a new report
- At the top right, click on
New report icon.
- Fill in the fields.
- Choose a report file (*.rep or *.jrxml)
- Click the Create button.
Edit a report
- Click on
Edit report icon.
- Modify the fields.
- Optionally choose a report file (*.rep or *.jrxml)
- Click the Edit button.
Delete a report
- Click on
Delete report icon.
- Click the Delete button.
Show report parameters
Optionally, reports can require parameters for execution.
For example, a range of dates. These parameters will be shown as a form in the user interface when the report is executed.
- Click on
Report params icon.
Execute a report
- Click on the
Execute report icon.
- Fill in the fields (when the report comes with parameters).
- Choose a report output format
PDF format.
RTF format.
CSV format.