This was developed to be a plugin (operator) to the precision framework. But it worked so well independently and it can be so useful to everyone for quick reporting that we thought it is best open sourced. It is a simple tool that given an RDBMS table it generates a data dump of that table in excel, csv, doc, pdf and whole lot of formats.
Test It uses -
- Bash 4+ [Tested on Linux and Mac only]
- JaspersStarter : http://jasperstarter.cenote.de [Library is packaged
- Java 8
- JasperReports [Library is packaged]
- sqlclient
- mysql - if you are using MySQL
- sqlplus - if you are using Oracle
git clone https://github.com/prashantevolvus/precision-jasper-operator.git
File format report_name,table_name,report_header
report_name - This is used to identify the report. This will be used for the report file name.
table_name - If only table name is provided It will search for the table in default schema specified in DB_DEF_SCHEMA/USER in configuration file (.config.sh).
It can be qualified with schema/user like owner.table_name
report_header - Descriptive report header inside the report.
.config.sh has the properties that connects to Database. Right now only MySQL and Oracle is supported.
JasperReports uses JDBC driver to connect to the database. Since most JDBC drivers have complicated licensing issue, we do not ship the driver.
You need to copy the JDBC driver in the lib directory
Usage: run.sh [-m=<Mode>] [-c=<Container File Name> | -d=<Direct details>] [-f=<Report format>]
| Parameter | Parameter Name | Mandatory | Possible Values | Description |
|---|---|---|---|---|
| -m | Mode | Optional (Defaults to BOTH) | BOTH / COMPILE / EXECUTE | COMPILE : Generates JRXML and Compiles to JASPER EXECUTE : Generates Report (Assumes JRXML was created previously) BOTH : COMPILES AND EXECUTES |
| -c | Container File Name | Mandatory | Filename | Filename usually .reg file. Provide full path or it will pick from current directory |
| -d | Direct details | Mandatory | <report_name>,<table_name>,<report_header> | comma separated single report to be generated |
| Either provide -c=Container File Name or -d=Direct details |
||||
| -f | Report format | Optional (Default xlsx) | view, xlsx, csv, pdf, rtf, xls, xlsMeta, docx, odt, ods, pptx, csvMeta, html, xhtml, xml, jrprint | Report format to be generated |
Use the .config.sh to customise your report Some of the things that you can customise is given below. Make sure that the fonts configured are available in the Linux otherwise jasper report does not compile.
The link below provides simple instruction to install the fonts - https://medium.com/source-words/how-to-manually-install-update-and-uninstall-fonts-on-linux-a8d09a3853b0
COLUMN_BACK_COLOR="#CEDE1F"
COLUMN_FONT_TYPE="Arial"
COLUMN_FONT_SIZE="12"
COLUMN_HEIGHT="15"
HEADER_BACK_COLOR="#CEDE1F"
HEADER_FONT_TYPE="Arial"
HEADER_FONT_SIZE="16"
HEADER_HEIGHT="30"
Refer MS Excel help for date and float formats
FLOAT_PATTERN=#,##0.00
DATE_PATTERN="d-M-yyyy"
| Library | License | Version |
|---|---|---|
| argparse4j | 0.5.0 | MIT |
| commons-beanutils | 1.9.3 | Apache 2.0 |
| commons-collections | 3.2.2 | Apache 2.0 |
| commons-digester | 2.1.0 | Apache 2.0 |
| commons-logging | 1.1.1 | Apache 2.0 |
| itext | 2.1.7 | AGPL |
| jasperreports | 6.7.0 | LGPL |
| jasperreports-fonts | 6.0.0 | LGPL |
| jasperstarter | - | Apache 2.0 |
| log4j | 1.2.17 | Apache 2.0 |
| poi | 3.17 | Apache 2.0 |
| rhino | 1.7.7.2 | MPL 2.0 |
| Action No | Action | Priority | Status |
|---|---|---|---|
| 1 | Right now it supports MySQL and Oracle. Need to support more RDBMS | Low | Open |
| 2 | Integrate with Precision100 | High | Open |
| 3 | Support CSV and PDF and make that configurable | High | Done |
| 4 | Execute individual report within the container through parameter | High | Done |
| 5 | Banner at the start up | Low | Open |
| 6 | remove dependency on sql clients | Low | Open |
A big thank you to -
- Team of JasperStarter (http://jasperstarter.cenote.de/team-list.html) and specially to Volker Voßkämper and Barbora Berlinger.
- Jasper Reports team