Documentation

User Tools

Site Tools

Trace:
jasperreports_developer_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
jasperreports_developer_guide [2022/02/21 19:36] – created ghacheyjasperreports_developer_guide [2024/06/18 01:28] (current) – ghachey
Line 1: Line 1:
-====== JasperReports Reporting Framework ======+====== JasperReports Developer Guide ======
  
 While the system can potentially support JasperReports, SQL Reporting Services and others the currently mostly used reporting platform is JasperReports from [[https://community.jaspersoft.com|JasperSoft Community]], a mature reporting platform including the engine, a visual designer and a reports server. While the system can potentially support JasperReports, SQL Reporting Services and others the currently mostly used reporting platform is JasperReports from [[https://community.jaspersoft.com|JasperSoft Community]], a mature reporting platform including the engine, a visual designer and a reports server.
Line 21: Line 21:
   * Provide appropriate security for JasperReports Server (i.e. change default username and password at minimum) at least for production development.   * Provide appropriate security for JasperReports Server (i.e. change default username and password at minimum) at least for production development.
  
-===== Jasper Technologies Configuration =====+===== Download the Pacific EMIS Source Code =====
  
-Assuming you have already cloned the software repository and installed Jasper as in previous step you are almost ready to get started. The first thing to do is to set your Jaspersoft Studio Workspace to point to the location where all the reports for this project are located. For example, the docs clone the software repository into the ''C:\'' directly. If you did the same then it means all reports for this software project are located in ''C:\pineapples\JaspersoftWorkspace\'' and you would change the workspace to look like the following. You can do this from main menu's ''File - Switch Workspace''.+You should first create a clone of the [[https://github.com/ghachey/pacific-emis-reports|Pacific EMIS Reports repository]] and check it out on your own computer. 
 + 
 +===== Jaspersoft Workspace ===== 
 + 
 +Set your Jaspersoft Studio Workspace to point to the location where all the reports for this project are located. For example, you may have cloned it in ''C:\Uses\Youruser\Development\JaspersoftWorkspace\'' and you would change the workspace to look like the following. You can do this from main menu's ''File - Switch Workspace''.
  
 {{ :developer-manual:jasper-workspace-switch.png?nolink |}} {{ :developer-manual:jasper-workspace-switch.png?nolink |}}
  
-Second thing, since we are using the MS SQL Server database we will need to install the [[https://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774|SQL Server JDBC driver]]. You can install this anywhere but you will need to know where since you will need to tell Jaspersoft Studio where it is. As shown in the illustration below click on Project Explorer, MyReports and Properties. Then Java Build Path, Libraries and Add External JARs. From where you browse and locate your sqljdbcXX.jar (where XX is the latest version you have installed). Add it and Apply.+===== Jaspersoft Set Java Build Path ===== 
 + 
 +There are a few things to add to the Java build path for things to compile correctly. As shown in the illustration below click on Project Explorer, MyReports and Properties. Then Java Build Path, Libraries and Add External JARs. 
 + 
 +  * Install the [[https://docs.microsoft.com/en-us/sql/connect/jdbc/download-microsoft-jdbc-driver-for-sql-server?view=sql-server-ver15|SQL Server JDBC driver]]. 
 +  * Font extension (Jar file can be found in the Pacific EMIS Report source code repository) 
 +  * Chart customizer (Jar file can be found in the Pacific EMIS Report source code repository)
  
 {{ :developer-manual:jasper-add-jdbc-driver.png?nolink |}} {{ :developer-manual:jasper-add-jdbc-driver.png?nolink |}}
  
-Furthermore, in production some reports require the following configuration to be changed to run stored procedures. Locate the file C:\Jaspersoft\jasperreports-server-7.1.0\apache-tomcat\webapps\jasperserver-pro\WEB-INF\classes\esapi\security-config.properties and set the following+===== Jaspersoft Setup Data Adaptors ===== 
 + 
 +Setup data adaptors for all databases you will be developing for. Example shown below. 
 + 
 +{{ :developer-manual:jasperstudio-create-data-adaptors.jpeg?nolink |}}
  
-<code> 
-security.validation.sql.on=false 
-</code> 
  
 +===== Jaspersoft Setup Servers =====
 +
 +Setup serversconnections for all databases you will be developing for. Example shown below.
 +
 +{{ :developer-manual:jasper-servers.png?nolink |}}
 +
 +
 +===== Jaspersoft Publishing Strategy to JasperServer =====
 +
 +The adopted publishing strategy for all Pacific EMIS reports is to always override all resources when reports modifications such as improvements or fixes are made. Use local resources for any subreport and link resources for the following which are on the JasperServer in a single place for better re-usability.
 +
 +  * Images
 +  * Templates
 +  * Input controls (parameters)
 +
 +{{ :developer-manual:jasperserver-publish-strategy-1.png?nolink |}}
 +
 +To make this mostly automatic you can change the following setting.
 +
 +{{ ::jasperserver-publish-strategy-2.png?nolink |}}
 ===== Reports Structure ===== ===== Reports Structure =====
  
Line 120: Line 151:
 ===== Integration with Pacific EMIS ===== ===== Integration with Pacific EMIS =====
  
-To effectively integrate the JasperReport server with the Pacific EMIS you need to make sure the relevant part of the Web.Config is edited accordingly (i.e. jasperUrl, jasperUser, jasperPass). This would likely be different whether you are working in development or deploying to production. +Refer to the [[JasperReports Systems Administrator Guide]]
- +
-<code xml> +
-  <appSettings> +
-    <add key="server" value="localhost" /> +
-    <add key="database" value="fedemis-test" /> +
-    <add key="context" value="fedemis" /> +
-    <add key="title" value="FedEMIS Online" /> +
-    <add key="ReportServerUrl" value="http://localhost:8080/reportserver" /> +
-    <add key="jasperUrl" value="http://localhost:8082/jasperserver" /> <!-- Reports feature will not work unless JasperServer deployed correctly --> +
-    <add key="jasperUser" value="jasperadmin" /> +
-    <add key="jasperPass" value="jasperadmin" /> +
-    <add key="FileDb" value="c:\files\filedb" /> <!-- This must be set with folder created on filesystem or documents feature will not work --> +
-  </appSettings> +
-</code> +
- +
-===== Helical Notes ===== +
- +
-<note warning>This is merely a dump from Helical documentation notes. Needs cleanup.</note> +
- +
-Folder Structure +
- +
-  * **Images** This Folder Includes all the images which we used in all the .jrxml file,If we used any new image in report so need to add that in Images Folder and image path in the report should be this folder image path. +
- +
-  * **Templates** This Folder includes all the .jrtx files which is used to apply particular styles in reports. +
-  * **Indicators** Their is Two sub folder in Indicators +
-    * Indicators Report National This folder includes all .jrxml files related Indicators by Nation +
-    * Indicators Report by State This folder includes all .jrxml files related Indicators by State +
-  * School It contains one sub folder and few other individual reports +
-    * School Report Card This folder includes all .jrxml files related to School Report Card +
-  * Schools This folder includes all .jrxml files related to Schools +
-  * Students This folder includes all .jrxml files related to Students +
-  * Teacher This folder includes all .jrxml files related to Teacher +
-  * Teachers Their is Two sub folder in Indicators +
-    * Teachers Report by Summary This folder includes all .jrxml files related Teachers reports by Nation +
-    * Teachers report by Nation This folder includes all .jrxml files related Teachers reports by State +
- +
-SQL Property Update: We need to disable the SQL validation property +
-Path: …\<Jasper Server>\apache-tomcat\webapps\jasperserver\WEB-INF\classes\esapi +
-File Name: security-config.properties +
-Property: security.validation.sql.on +
-Update the above property to false and restart the server +
- +
-Required Libraries: +
-  * font-extension.jar: It is used to support the new custom fonts in jasper server +
-  * reporting-1.0.jar: This jar is used for chart customizer to customize the chart colors +
-  * sqljdbc4-2.0.jar: This is used for creating jdbc connection. We can add this driver in both Jasper server and Jaspersoft studio if sql jdbc driver not imported +
-   +
-Add both the jar files in jasper server library folder +
-Path: …\<Jasper Server>\apache-tomcat\webapps\jasperserver\WEB-INF\lib +
- +
-Restart the server +
- +
-You also need to install open-sans fonts in Windows and Jasper: +
- +
-  * Go to Window -> Preferences -> Jaspersoft Studio -> Fonts. Click on Add from path and select the zip file.  +
-  * Install in JasperSoft Studio +
- +
-{{:developer-manual:jasper-add-font.png?nolink|}} +
- +
- +
jasperreports_developer_guide.1645472175.txt.gz · Last modified: 2022/02/21 19:36 by ghachey