Pentaho Reporting Plugin for Apache Fineract

For Users

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

    mkdir pentahoReports

2. Export the FINERACT_PENTAHO_REPORTS_PATH variable

    export FINERACT_PENTAHO_REPORTS_PATH="$PWD/pentahoReports/"

3. Download link for Fineract Pentaho Plugin and extract the files (java jar files are on it)

4a. Execute only for DOCKER - Create a directory, copy the Fineract Pentaho Plugin and the Pentaho libraries in it

    mkdir fineract-pentaho  && cd fineract-pentaho

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

5. Restart Docker or Tomcat

6. Test the Pentaho Reports

For Developers

Add the repository https://mifos.jfrog.io/artifactory/libs-snapshot-local/

Maven

    <dependency>
        <groupId>community.mifos</groupId>
        <artifactId>pentaho-plugin</artifactId>
        <version>1.10.0-SNAPSHOT</version>
    </dependency>

Gradle

    compile(group: 'community.mifos', name: 'pentaho-plugin', version: '1.10.0-SNAPSHOT')

Download, Unzip and Use the binaries

    mkdir fineract-pentaho  && cd fineract-pentaho
    wget https://mifos.jfrog.io/artifactory/libs-snapshot/community/mifos/pentaho-plugin/1.10.0-SNAPSHOT/pentaho-plugin-1.10.0-20240422.141908-3.jar

Build & Use For Linux Users

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

1. Download and compile

    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

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

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

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

    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' \
--header 'Fineract-Platform-TenantId: default' \
--header 'Authorization: Basic bWlmb3M6cGFzc3dvcmQ='

5. The output must be a PDF with the Expected Payment By Date Formated information in it (maybe it could have blank or zeroes if it is a fresh Fineract Setup)

The API call (above) should not fail if you follow the steps as shown, and all conditions met for the version of Apache Fineract

If the API call (above) fails with "There is no ReportingProcessService registered in the ReportingProcessServiceProvider for this report type: Pentaho", then this Fineract 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 (14th February 2024), also make sure you got installed the type fonts required by the reports. This Pentaho plugin will work only on Tomcat 10+.

See also PentahoReportsTest and the test script.

License

This code used to be part of the Mifos codebase before it became Apache Fineract. 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). This is a separate question than the license that Pentaho itself (i.e. the JAR/s of Pentaho) are made available under.

Contribute

If this Fineract plugin project is useful to you, please contribute back to it (and 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. The original work is this one https://github.com/vorburger/fineract-pentaho.

See TODO 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