jasperreports_systems_administrator_guide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| jasperreports_systems_administrator_guide [2024/03/23 01:52] – [Catalog Restoration] ghachey | jasperreports_systems_administrator_guide [2024/04/10 07:05] (current) – [Required Libraries] ghachey | ||
|---|---|---|---|
| Line 41: | Line 41: | ||
| security.validation.sql.on=false | security.validation.sql.on=false | ||
| </ | </ | ||
| + | |||
| + | ===== Firewall ===== | ||
| + | |||
| + | Tomcat bundled with the JasperServer is already configured to be able to listen on external interfaces. But the windows firewall would block it by default. The safest is to only open the port 8080 to those who will access the JasperServer directly. This usually means administrators and developers as all reports are made available directly in the Pacific EMIS web application. | ||
| ===== Integration with Pacific EMIS ===== | ===== Integration with Pacific EMIS ===== | ||
| + | |||
| + | A powerful feature of the Pacific EMIS is its seamless integration with a high end enterprise grade reporting server called JasperReport Server (aka. JasperServer). | ||
| + | |||
| + | <note warning> | ||
| + | ==== Configuration of the Web Application ==== | ||
| 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. | 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. | ||
| Line 59: | Line 68: | ||
| </ | </ | ||
| </ | </ | ||
| - | ===== Helical Notes ===== | + | ==== Folder Structure |
| - | <note warning> | + | The folders follow |
| - | Folder Structure | + | * **Images** Includes all the images which we used in all the .jrxml file. So images in reports should point to the repo: link before they are deployed in the JasperReport Server. This does require a annoying switching of the images links in the report when working between development in JasperSoft Studio and production in JasperServer. |
| + | * **Templates** Similarly to images, this folder includes all the .jrtx files which is used to apply particular styles in reports. The advantage of centralizing styles are well known. The same annoying switching of the links is reports is require before deploying. | ||
| - | * **Images** This Folder Includes | + | Then there are all the folders that hold the reports. The Pacific EMIS is usually made up of simple modules (e.g. Schools, Teachers, Exams). Each of those modules typically have individual entities (e.g. an individual School, an individual Teacher.) Reports can be designed and place in particular folders |
| - | * **Templates** This Folder includes all the .jrtx files which is used to apply particular styles in reports. | + | For example, if you want a new report to go under the Schools (e.g. List of school without annual census submission this year) module you would design it and put in a a folder **Schools**. |
| - | * **Indicators** Their is Two sub folder | + | |
| - | * Indicators Report National This folder | + | |
| - | | + | |
| - | | + | |
| - | * School Report Card This folder includes all .jrxml files related to School Report Card | + | |
| - | * Schools This folder includes all .jrxml files related to Schools | + | |
| - | | + | |
| - | | + | |
| - | * Teachers Their is Two sub folder in Indicators | + | |
| - | * Teachers Report by Summary This folder includes | + | |
| - | * 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 | + | {{ :sysadmin-manual:jasperreports-integration-1.png?nolink |}} |
| - | Path: …\< | + | |
| - | File Name: security-config.properties | + | |
| - | Property: security.validation.sql.on | + | |
| - | Update the above property to false and restart the server | + | |
| - | Required Libraries: | + | Now if you wanted to have a report for individual schools (e.g. A School Report Card). You would locate it in a folder called **School** (not without the plural " |
| - | * font-extension.jar: | + | {{ : |
| - | * reporting-1.0.jar: | + | |
| - | * sqljdbc4-2.0.jar: This is used for creating jdbc connection. | + | The same will work for any other module (i.e. Indicators, Exams, Teachers, Individual Teachers, etc.) |
| + | |||
| + | ==== Required Libraries | ||
| + | |||
| + | Some or all reports require some additional jar files in essence small dependencies. They are listed and described here. | ||
| + | |||
| + | | ||
| + | | ||
| + | * **sqljdbc-VERSION.jar**: Used for JBDC connection | ||
| | | ||
| - | Add both the jar files in jasper | + | Restart |
| - | Path: …\< | + | |
| - | Restart the server | + | ==== Fonts ==== |
| - | You also need to install | + | Reports have been standardized using the Open Sans famliy of fonts so those will need to be installed on the Windows Server. Just download them from https:// |
| - | * Go to Window -> Preferences -> Jaspersoft Studio -> Fonts. Click on Add from path and select the zip file. | + | Note that if you are designing reports you will also need to install them on your own workstation and you could also install them directly in the JasperSoft Studio. To do this you would go to **Window -> Preferences -> Jaspersoft Studio -> Fonts**. Click on Add from path and select the zip file. Install in JasperSoft Studio |
| - | * Install in JasperSoft Studio | + | |
| {{: | {{: | ||
| Line 178: | Line 179: | ||
| I have found useful to temporarily change the passwords as using it later cause me more problem then I wanted to solved (special characters not handling well on the windows command line). | I have found useful to temporarily change the passwords as using it later cause me more problem then I wanted to solved (special characters not handling well on the windows command line). | ||
| - | Change password of the keystore. | + | Change password of the keystore. I made it a convenient easy to type password since it is temporary and the keystore will be disposed later. |
| < | < | ||
| Line 184: | Line 185: | ||
| </ | </ | ||
| - | Change password of the key of interest. | + | Change password of the key of interest. This password could also be made simple and convenient but then you would be best to change it in the production stored after ward for tighter security. Another approach is to make it a good password right away and as it gets imported it keeps this password. |
| < | < | ||
| >keytool -v -keypasswd -storetype jceks -keystore C: | >keytool -v -keypasswd -storetype jceks -keystore C: | ||
| </ | </ | ||
| + | |||
| + | <note tip> | ||
| Changing the password made it easier to import and override the key in the new keystore generated from a fresh installation on the new server. Note that the only key being imported and in effect overriding the default one of the new installation is the importExportEncSecret key. | Changing the password made it easier to import and override the key in the new keystore generated from a fresh installation on the new server. Note that the only key being imported and in effect overriding the default one of the new installation is the importExportEncSecret key. | ||
| Line 199: | Line 202: | ||
| {{ : | {{ : | ||
| + | |||
| + | Once that the catalog has been successfully been updated you can do some final cleanups including: | ||
| + | |||
| + | * Dispose of the original keystore (.jrsks and jrsksp from the previous server). They were tempered with changing to simple passwords for convenience and are no longer needed. Keep the original backup in the backup server of course. | ||
| + | * The new keystore from the fresh installation on the new server now has a new secure password, but the imported and overriden key alias importExportEncSecret has the simple password carried from the change above. It would be a better idea to change it again to a strong password using the same technique as above but on the new keystore (you will need the new password which you can obtain from adapted commands above). If you do change the password for the key importExportEncSecret then you would also need to decode the properties (.jrsksp) edit the base64 string for that key and encode it again using the following command. | ||
| + | |||
| + | < | ||
| + | > | ||
| + | </ | ||
| + | |||
| + | <note important> | ||
| There are actually a few different ways to handle backup and restores with more recent and secure JasperServer versions. More details can be found in the guide JasperReport Server Security Guide. | There are actually a few different ways to handle backup and restores with more recent and secure JasperServer versions. More details can be found in the guide JasperReport Server Security Guide. | ||
jasperreports_systems_administrator_guide.1711158735.txt.gz · Last modified: 2024/03/23 01:52 by ghachey