node-jasper-report
Advanced tools
Readme
JasperReports within Node.js
https://epwt-www.mybluemix.net/software/support/trial/cst/programwebsite.wss?siteId=854&h=null&p=null https://sourceforge.net/projects/jasperreports/files/archive/jasperreports/JasperReports%206.1.0/jasperreports-6.1.0-project.tar.gz/download
if you don't have a java Install java jre-8u251(Java SE 8) and java jdk
Install via npm:
npm install node-gyp -g
npm install --global --production windows-build-tools(if does not work try installing python, vs2017 c++ manually)
npm install node-jasper-report
To use it inside your project just do:
var jasper = require('node-jasper-report')(options);
Where options is an object with the following signature:
options: {
path: , //Path to jasperreports-x.x.x directory (from jasperreports-x.x.x-project.tar.gz)
reports: {
// Report Definition
"name": {
jasper: , //Path to jasper file,
jrxml: , //Path to jrxml file,
conn: , //Connection name, definition object or false (if false defaultConn won't apply or if ´in_memory_json´ then you can pass an JSON object in the ´dataset´ property for in-memory data sourcing instead of database access
}
},
drivers: {
// Driver Definition
"name": {
path: , //Path to jdbc driver jar
class: , //Class name of the driver (what you would tipically place in "Class.forName()" in java)
type: //Type of database (mysql, postgres)
}
},
conns: {
// Connection Definition
"name": {
host: , //Database hostname or IP
port: , //Database Port
dbname: , //Database Name
user: , //User Name
pass: , //User Password
jdbc: , //jdbc connection String. If this is defined, every thing else but user and pass becomes optional.
driver: //name or definition of the driver for this conn
}
},
defaultConn: ,//Default Connection name
java: ,//Array of java options, for example ["-Djava.awt.headless=true"]
javaInstnace: //Instance of node-java, if this is null, a new instance will be created and passed in 'java' property
}
java
Instance of node-java that we are currently running.
add(name, report)
Add a new report definition identified by name.
In report definition one of jasper or jrxml must be present.
pdf(report)
Alias for export(report, 'pdf')
export(report, format)
Returns the compiled report in the specified format.
report can be of any of the following types:
A string that represents report's name. No data is supplied.. defaultConn will be applied to get data with reports internal query.
An object that represents report's definition. No data is supplied.. if conn is not present, then defaultConn will be applied to get data with reports internal query.
An object that represents reports, data and properties to override for this specific method call.
{
report: , //name, definition or an array with any combination of both
data: {}, //Data to be applied to the report. If there is an array of reports, data will be applied to each.
override: {} //properties of report to override for this specific method call.
dataset: {} //an object to be JSON serialized and passed to the Report as fields instead of parameters (see the example for more info)
query: '' // string to pass to jasperreports to query on the dataset
}
An array with any combination of the three posibilities described before.
A function returning any combination of the four posibilities described before.
var express = require('express'),
app = express(),
jasper = require('node-jasper')({
path: 'lib/jasperreports-6.1.0',
reports: {
hw: {
jasper: 'reports/helloWorld.jasper'
}
},
drivers: {
pg: {
path: 'lib/postgresql-9.2-1004.jdbc41.jar',
class: 'org.postgresql.Driver',
type: 'postgresql'
}
},
conns: {
dbserver1: {
host: 'dbserver1.example.com',
port: 5432,
dbname: 'example',
user: 'johnny',
pass: 'test',
driver: 'pg'
}
}
defaultConn: 'dbserver1'
});
app.get('/pdf', function(req, res, next) {
//beware of the datatype of your parameter.
var report = {
report: 'hw',
data: {
id: parseInt(req.query.id, 10)
secundaryDataset: jasper.toJsonDataSource({
data: ...
},'data')
}
dataset: //main dataset
};
var pdf = jasper.pdf(report);
res.set({
'Content-type': 'application/pdf',
'Content-Length': pdf.length
});
res.send(pdf);
});
app.listen(3000);
var express = require('express'),
app = express(),
jasper = require('node-jasper-report')({
path: 'lib/jasperreports-6.1.0',
reports: {
hw: {
jasper: 'reports/helloWorld.jasper'
}
},
drivers: {
db2: {
path: 'lib/db2jcc4.jar',
class: 'com.ibm.db2.jcc.DB2Driver',
type: 'db2'
}
},
conns: {
dbserver1: {
host: 'dbserver1.example.com',
port: 5432,
dbname: 'example',
user: 'kevin pogi',
pass: 'kevin pogi',
driver: 'db2'
}
}
defaultConn: 'dbserver1'
});
app.get('/xlsx', function(req, res, next) {
//beware of the datatype of your parameter.
var report = {
report: 'hw',
data: {
id: parseInt(req.query.id, 10)
secundaryDataset: jasper.toJsonDataSource({
data: ...
},'data')
}
dataset: //main dataset
};
var resp = jasper.export(
{
report: 'jasper_report',
data: {
name: 'Gonzalo',
lastname: 'Pogi',
},
dataset: [
{
name: 'Gonzalo',
lastname: 'Vinas' // TODO: check on UTF-8
},
{
name: 'Agustin',
lastname: 'Moyano'
}
]
},
'xlsx'
)
res.send(resp);
});
app.listen(3000);
var express = require('express'),
app = express(),
jasper = require('node-jasper-report')({
path: 'lib/jasperreports-6.1.0',
autoCompileReportsPath: 'folder path of jrxml files', //compiles report automatically
reports: {
hw: {
jasper: 'reports/helloWorld.jasper'
}
},
drivers: {
db2: {
path: 'lib/db2jcc4.jar',
class: 'com.ibm.db2.jcc.DB2Driver',
type: 'db2'
}
},
conns: {
dbserver1: {
host: 'dbserver1.example.com',
port: 5432,
dbname: 'example',
user: 'kevin pogi',
pass: 'kevin pogi',
driver: 'db2'
}
}
defaultConn: 'dbserver1'
});
app.get('/docx', function(req, res, next) {
//beware of the datatype of your parameter.
var report = {
report: 'hw',
data: {
id: parseInt(req.query.id, 10)
secundaryDataset: jasper.toJsonDataSource({
data: ...
},'data')
}
dataset: //main dataset
};
var resp = jasper.export(
{
report: 'jasper_report',
data: {
name: 'Gonzalo',
lastname: 'Pogi',
},
dataset: [
{
name: 'Gonzalo',
lastname: 'Vinas' // TODO: check on UTF-8
},
{
name: 'Agustin',
lastname: 'Moyano'
}
]
},
'docx'
)
res.send(resp);
});
app.listen(3000);
That's It!. Note that compiling jrxml to jasper only works on jasperreports-6.1.0.
FAQs
Used to generate report from ".jasper" file to pdf and xlsx
The npm package node-jasper-report receives a total of 31 weekly downloads. As such, node-jasper-report popularity was classified as not popular.
We found that node-jasper-report demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.