Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@IOhacker
IOhacker authored Dec 31, 2024
1 parent 3a36147 commit 76a7e6c
Showing 1 changed file with 22 additions and 27 deletions.
49 changes: 22 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Pentaho® Reporting Plugin for Apache Fineract®
# Mifos® Reporting Plugin for Apache Fineract®

## For Users

1. Create a directory for the Pentaho® reports and copy the PRPT files in it
1. Create a directory for the Mifos® reports and copy the PRPT files in it

```bash
mkdir pentahoReports
Expand All @@ -14,45 +14,44 @@
export FINERACT_PENTAHO_REPORTS_PATH="$PWD/pentahoReports/"
```

3. [Download link for Pentaho Plugin ](https://sourceforge.net/projects/mifos/files/mifos-plugins/FineractPentahoPlugin/FineractPentahoPlugin-1.10.0.zip/download) and extract the files (java jar files are on it)
3. [Download link for Mifos® Reporting Plugin ](https://sourceforge.net/projects/mifos/files/mifos-plugins/FineractPentahoPlugin/FineractPentahoPlugin-1.10.0.zip/download) and extract the files (java jar files are on it)

4a. Execute only for DOCKER - Create a directory, copy the Pentaho Plugin and the Pentaho libraries in it
4a. Execute only for Docker® - Create a directory, copy the Mifos® Reporting Plugin and the Pentaho® libraries in it

```bash
mkdir fineract-pentaho && cd fineract-pentaho
```

4b. Execute only for TOMCAT - Copy the Pentaho® Plugin and Pentaho® libraries in $TOMCAT_HOME/webapps/fineract-provider/WEB-INF/lib/
4b. Execute only for Apache Tomcat® - Copy the Mifos® Reporting Plugin and Pentaho® libraries in $TOMCAT_HOME/webapps/fineract-provider/WEB-INF/lib/

5. Restart Docker or Tomcat
5. Restart Docker® or Apache Tomcat®

6. Test the Pentaho® Reports
6. Test the Mifos® reports.

## For Developers

This project is currently only tested against the very latest and greatest
bleeding edge Apache Fineract® `develop` branch on Linux Ubuntu 24.04LTS. Building and using it against
other versions may be possible, but is not tested or documented here.
This project is currently only tested against the very latest and greatest bleeding edge Apache Fineract® `develop` branch on Linux Ubuntu 24.04LTS.
Building and using it against other Apache Fineract® versions may be possible, but is not tested or documented here.

1. Download and compile

```bash
git clone https://github.com/openMF/fineract-pentaho.git
cd fineract-pentaho && ./mvnw -Dmaven.test.skip=true clean package && cd ..
```
2. Export the Location of Pentaho Reports (prpt files) in a variable required by the Plugin
2. Export the Location of Mifos® reports (PRPT files) in the following variable

```bash
export FINERACT_PENTAHO_REPORTS_PATH="$PWD/fineract-pentaho/pentahoReports/"
```

3. Execute Apache Fineract® with the location of the Pentaho Plugin library
3. Execute Apache Fineract® with the location of the Mifos® Reporting Plugin library

```bash
java -Dloader.path=$MIFOS_PENTAHO_PLUGIN_HOME/libs/ -jar $APACHE_FINERACT_HOME/fineract-provider.jar
```

4. Test the Pentaho® Reports Execution using the following curl example or through the Mifos Web App in the Reports Menu
4. Test the Mifors® reports execution using the following curl example or through the Mifos Web App in the Reports Menu

```bash
curl --location --request GET 'https://localhost:8443/fineract-provider/api/v1/runreports/Expected%20Payments%20By%20Date%20-%20Formatted?tenantIdentifier=default&locale=en&dateFormat=dd%20MMMM%20yyyy&R_startDate=01%20January%202022&R_endDate=02%20January%202023&R_officeId=1&output-type=PDF&R_loanOfficerId=-1' \
Expand All @@ -70,45 +69,41 @@ If the API call (above) [fails with](https://issues.apache.org/jira/browse/FINER
_`"There is no ReportingProcessService registered in the ReportingProcessServiceProvider for this report type: Pentaho"`_,
then this Pentaho® Plugin has not been correctly registered & loaded by Apache Fineract®.

Please note that the library will work using the latest Apache Fineract® development branch (30th December 2024), also make sure you got installed the type fonts required by the reports. This Pentaho® plugin will work only on Tomcat 10+.
Please note that the library will work using the latest Apache Fineract® development branch (30th December 2024), also make sure you got installed the type fonts required by the reports. This Mifos® Reporting Plugin will work only on Apache Tomcat® version 10+.

See also [`PentahoReportsTest`](src/test/java/org/mifos/fineract/pentaho/PentahoReportsTest.java) and the [`test`](test) script.


## License

This code used to be part of the Mifos codebase before it became [Apache Fineract®](https://fineract.apache.org).
During that move, the Pentaho® related code had to be removed, because Pentaho®'s license
prevents code using it from being part of an Apache Software Foundation® hosted project.
This code used to be part of the Mifos® codebase before it became [Apache Fineract®](https://fineract.apache.org).
During that move, the Pentaho® related code had to be removed, because Pentaho®'s license prevents code using it from being part of an Apache Software Foundation® hosted project.

The correct technical solution to resolve such conundrums is to use a plugin architecture - which is what this is.

Note that the code and report templates in this git repo itself are
[licensed to you under the Mozilla Public License 2.0 (MPL)](https://github.com/openMF/fineract-pentaho/blob/develop/LICENSE).
[licensed to you under the Mozilla® Public License 2.0 (MPL)](https://github.com/openMF/fineract-pentaho/blob/develop/LICENSE).
This is a separate question than the license that Pentaho® itself (i.e. the JAR/s of Pentaho®) are made available under.

## Important

* Mifos and Pentaho® Plugin are not affiliated with, endorsed by, or otherwise associated with the Apache Software Foundation® (ASF) or any of its projects.
* Mifos® and Mifos® Reporting Plugin are not affiliated with, endorsed by, or otherwise associated with the Apache Software Foundation® (ASF) or any of its projects.
* Apache Software Foundation® is a vendor-neutral organization and it is an important part of the brand is that Apache Software Foundation® (ASF) projects are governed independently.
* Apache Fineract®, Fineract, Apache, the Apache® feather, and the Apache Fineract® project logo are either registered trademarks or trademarks of the Apache Software Foundation®.
* Mifos and Pentaho® Plugin are not affiliated with, endorsed by, or otherwise associated with Hitachi Vantara LLC or any of its projects.
* Mifos® and Mifos® Reporting Plugin are not affiliated with, endorsed by, or otherwise associated with Hitachi Vantara LLC or any of its projects.
* Hitachi® and Hitachi Vantara® are registered trademarks of Hitachi, Ltd. in the U.S. and other countries. Pentaho® is a registered trademark of Hitachi Vantara LLC in the U.S. and other countries.

## Contribute

If this plugin project is useful to you, please contribute back to it (and
Apache Fineract®) by raising Pull Requests yourself with any enhancements you make, and by helping
to maintain this project by helping other users on Issues and reviewing PR from others
(you will be promoted to committer on this project when you contribute). We recommend
that you _Watch_ and _Star_ this project on GitHub to make it easy to get notified.
If this Mifos® Reporting Plugin project is useful to you, please contribute back to it (and to Apache Fineract®) by raising Pull Requests yourself with any enhancements you make, and by helping to maintain this project by helping other users on Issues and reviewing PR from others (you will be promoted to committer on this project when you contribute).
We recommend that you _Watch_ and _Star_ this project on GitHub to make it easy to get notified.

## History

This is a [_Plugin_ for Apache Fineract®](https://github.com/apache/fineract/blob/maintenance/1.6/fineract-doc/src/docs/en/deployment.adoc). The original work is this one https://github.com/vorburger/fineract-pentaho.
This is a [Mifos® Reporting Plugin for Apache Fineract®](https://github.com/apache/fineract/blob/maintenance/1.6/fineract-doc/src/docs/en/deployment.adoc). The original work is this one https://github.com/vorburger/fineract-pentaho.

See [TODO](TODO.md) for possible future follow-up enhancement work.

The Pentaho reports has been updated to the version 9.5, please use the [`Pentaho Report Designer version 9.5`](https://mifos.jfrog.io/artifactory/libs-snapshot-local/org/pentaho/reporting/prd-ce/9.5.0.0-SNAPSHOT/prd-ce-9.5.0.0-20230108.081758-1.zip)
The Mifos® Reporting Plugin has been updated to the Pentaho® version 9.5, please use the [`Pentaho® Report Designer version 9.5`](https://mifos.jfrog.io/artifactory/libs-snapshot-local/org/pentaho/reporting/prd-ce/9.5.0.0-SNAPSHOT/prd-ce-9.5.0.0-20230108.081758-1.zip)


0 comments on commit 76a7e6c

Please sign in to comment.