mifos-reporting-plugin

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #android #rust #linux #docker #java #windows #awesome #awesome-list #vue #mcp #ios

mifos-reporting-plugin

(★ 35)

Mifos® X Reporting Plugin module - compatible with Apache Fineract® backend

mifos-reporting-plugin 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

```markdown
# Mifos® Reporting Plugin (Eclipse BIRT®) for Apache Fineract®

## Overview

This is the **Eclipse BIRT® (Business Intelligence and Reporting Tools)** implementation of the Mifos® X Reporting Plugin for Apache Fineract®.

It replaces the legacy Pentaho-based reporting system with a modern and lightweight reporting engine.

---

## For Users

### 1. Create Report Directories

Create directories for the Mifos® reports, fonts, and font configuration files:

```bash
mkdir -p /app/birt/reports /app/birt/fonts /app/birt/config
```

Copy the required **Report**, **Font Config**, and **Font** files into their respective directories.

### 2. Export the Required Variables

```bash
export MIFOS_BIRT_REPORTS_LOCALE=en
export MIFOS_BIRT_REPORTS_PATH=/app/birt/reports
export MIFOS_BIRT_REPORTS_FONTS_PATH=/app/birt/fonts
export MIFOS_BIRT_REPORTS_FONTS_CONFIG_PATH=/app/birt/config
```

### 3. Download the Mifos® Reporting Plugin

Download the Mifos® Reporting Plugin and extract the files.

> **Important:** Use the specific Mifos® Reporting Plugin version compatible with your Apache Fineract® version. All libraries required to run the plugin are included.

| Apache Fineract® | Mifos® Reporting Plugin | Download Link |
| --- | --- | --- |
| TBD | TBD | TBD |

### 4a. Docker® Installation

**Execute this step only when using Docker®.**

Create a directory for the Mifos® BIRT Plugin and Eclipse BIRT libraries:

```bash
mkdir fineract-birt && cd fineract-birt
```

Copy the Mifos® BIRT Plugin and the Eclipse BIRT libraries into this directory.

### 4b. Apache Tomcat® Installation

**Execute this step only when using Apache Tomcat®.**

Copy the Mifos® BIRT Plugin and Eclipse BIRT libraries into:

```text
$TOMCAT_HOME/webapps/fineract-provider/WEB-INF/lib/
```

### 5. Restart Apache Fineract®

Restart Docker® or Apache Tomcat® depending on your deployment setup.

### 6. Test the Mifos® Reports

After restarting Apache Fineract®, test the Mifos® reports to verify that the BIRT® reporting engine has been correctly registered and loaded.

---

## For Developers

This project is currently tested against the very latest Apache Fineract® `develop` branch on **Linux Ubuntu® 26.04 LTS**.

Building and using it against other Apache Fineract® versions may be possible, but those versions are currently not tested or documented here.

### 1. Download and Compile

Clone the repository and build the project:

```bash
git clone https://github.com/openMF/mifos-reporting-plugin.git && cd mifos-reporting-plugin && ./mvnw -Dmaven.test.skip=true clean package
```

### 2. Export the Variables Required

```bash
export MIFOS_BIRT_REPORTS_LOCALE=en
export MIFOS_BIRT_REPORTS_PATH=/app/birt/reports
export MIFOS_BIRT_REPORTS_FONTS_PATH=/app/birt/fonts
export MIFOS_BIRT_REPORTS_FONTS_CONFIG_PATH=/app/birt/config

# Paths for Fineract execution
export MIFOS_BIRT_PLUGIN_HOME=/path/to/mifos-reporting-plugin
export APACHE_FINERACT_HOME=/path/to/fineract
```

> **Note:** Replace `/path/to/mifos-reporting-plugin` and `/path/to/fineract` with the actual paths on your system.

### 3. Start Apache Fineract®

Start Apache Fineract® with the location of the Mifos® BIRT Plugin libraries:

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

### 4. Test the Mifos® Reports

Test the Mifos® reports execution using the following `curl` example or through the **Reports** menu in the Mifos® Web App.

*Ensure your configured Fineract API credentials are set in your environment variables (`FINERACT_USERNAME` and `FINERACT_PASSWORD`), or replace them directly in the command below.*

```bash
curl --location --request GET \
'https://localhost:8443/fineract-provider/api/v1/runreports/Active%20Loans%20-%20Details?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' \
--user "$FINERACT_USERNAME:$FINERACT_PASSWORD"
```

Using environment variables for the credentials avoids hardcoding authentication details directly into the command.

### 5. Verify the Output

The output should be a **PDF** containing the **Active Loans - Details** report.

If you are using a fresh Apache Fineract® installation, the report may contain blank values or zeroes because there may not be any loan data yet.

The API call above should succeed when:

* The Mifos® BIRT Plugin is correctly registered.
* The plugin version is compatible with the Apache Fineract® version.
* The required Eclipse BIRT® libraries are available.
* The required report files are installed.
* The required fonts and font configuration are installed.
* Apache Tomcat® 10+ is being used.
* The `MIFOS_BIRT_PLUGIN_HOME` and `APACHE_FINERACT_HOME` variables point to the correct locations.
* The Fineract® API credentials provided are valid.

If the API call fails after following the steps above, the BIRT® Plugin has likely not been correctly registered or loaded by Apache Fineract®.

> **Note:** This Mifos® Reporting Plugin currently works with Apache Tomcat® version **10+**.

Make sure that all font files required by the reports are also installed and available at the configured font path.

### Tests and Verification

To execute the test suite and verify the integrity of the migration pipeline and reporting engine, run the following Maven command from the project root:

```bash
./mvnw clean test
```

To generate the project's API documentation (Javadoc), run:

```bash
./mvnw javadoc:javadoc
```

The generated documentation will be available in:

```text
target/site/apidocs/
```

See also:

* [`BirtReportingProcessServiceImplTest`](src/test/java/org/apache/fineract/infrastructure/report/service/BirtReportingProcessServiceImplTest.java)
* [`test`](test) script.

---

# Pentaho to BIRT Migration Utility

This project includes an embedded **CLI orchestrator** designed to automatically batch-convert legacy Pentaho report archives (`.prpt`) into modern Eclipse BIRT XML report definitions (`.rptdesign`).

The migration utility allows multiple legacy Pentaho reports to be converted in a batch without requiring the Apache Fineract® Spring context to be started.

> **Prerequisite:** This utility and plugin require **Java 17+**, matching the baseline requirement for Apache Fineract®.

## Running the Migration CLI

The orchestrator can be executed directly from the terminal using the Maven `exec:java` plugin.

### 1. Default Execution

By default, the utility:

* Scans the `pentahoReports/` directory at the project root.
* Converts the available Pentaho reports.
* Writes the migrated BIRT report definitions to `target/migrated-reports/`.

Run:

```bash
./mvnw compile exec:java \
  "-Dexec.mainClass=org.apache.fineract.infrastructure.report.migration.orchestrator.MigrationCli"
```

### 2. Custom Input and Output Directories

Custom source and destination directories can be provided using the CLI flags.

* `-s` or `--source`: Specifies the source directory containing `.prpt` archives.
* `-f` or `--file`: Specifies a single `.prpt` file to migrate.
* `-t` or `--target`: Specifies the target directory for output `.rptdesign` files.

Example of batch converting a directory:

```bash
./mvnw compile exec:java \
  "-Dexec.mainClass=org.apache.fineract.infrastructure.report.migration.orchestrator.MigrationCli" \
  -Dexec.args="-s path/to/legacy/reports -t path/to/birt/output"
```

Example of migrating a single file:

```bash
./mvnw compile exec:java \
  "-Dexec.mainClass=org.apache.fineract.infrastructure.report.migration.orchestrator.MigrationCli" \
  -Dexec.args="-f pentahoReports/MariaDB/Legacy/Balance_Sheet.prpt -t target/migrated-reports"
```

### Migration Failure Handling

If the migration fails for specific reports because they contain unsupported legacy features:

* The CLI logs the failed reports.
* The migration continues for other reports where possible.
* The process exits with a **non-zero status code**.

The non-zero exit status makes migration failures visible in **CI/CD pipelines** and allows automated workflows to detect unsuccessful migrations.

---

## License

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/mifos-x-reporting-plugin/blob/dev/LICENSE).

---

## Important

* 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.
* The Apache Software Foundation® is a vendor-neutral organization, and an important part of its brand is that Apache Software Foundation® 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 Mifos® Reporting Plugin are **not affiliated with, endorsed by, or otherwise associated with** the Eclipse Foundation or any of its projects.
* Eclipse® and Eclipse BIRT® and the associated logos are registered trademarks of the Eclipse Foundation, Inc. The trademarks are used to identify the open-source business intelligence and reporting project hosted by the Eclipse Foundation.

---

## Contribute

If this Mifos® Reporting Plugin project is useful to you, please contribute back to the project.

You can contribute by:

* Raising Pull Requests with enhancements and bug fixes.
* Helping maintain the project.
* Helping other users through GitHub® Issues.
* Reviewing Pull Requests from other contributors.

Contributors who actively participate in the project may be promoted to **committer**.

We recommend that you **Watch** and **Star** this project on GitHub® to receive notifications about new activity.

---

## Eclipse BIRT Designer and SDKs

The Eclipse BIRT Designer and SDK update site is available at:

https://download.eclipse.org/birt/updates/release/latest/

mifos-reporting-plugin

mifos-reporting-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

mifos-reporting-plugin

mifos-reporting-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README