GSoC 2014 - Client Impact Portal
Target release | |
|---|---|
Epic | |
Source Code | |
Project Status | WORK IN PROGRESS |
Document status | DRAFT |
Document owner | @ChannaS |
Designer | @Sander van der Heyden |
Developers | @ChannaS |
QA |
Project Summary
Goals
Background, Impact, and User Need
Microfinance institutions usually work with various external parties, such as funders or investors. Using the data that is available in MifosX we would like to offer those stakeholders a seperate portal showing accurate and high-level information about the institution that would otherwise be reported manually by the institution. This information helps them in their decision making processes, but also enables them to assess the broader impact they are having with their funding.
Following high level information will be fetched from back end to show in front end UI application.
Loans | Description |
|---|---|
Outstanding Loans (principal) | Outstanding principal of all outstanding loans of the institution |
Outstanding Loans (number) | Total number of all outstanding loans of the institution |
PAR 1 (%) | The outstanding principal of all outstanding loans of the institution that have at least one payment >1 day in arrears divided by the Outstanding Loans and shown as a % |
PAR 30 (%) | The outstanding principal of all outstanding loans of the institution that have at least one payment >30 day in arrears divided by the Outstanding Loans and shown as a % |
Savings | Definition |
Voluntary Savings (amount) | Sum of the balances of all voluntary savings accounts in the institution |
Compulsory Savings (amount) | Sum of the balances of all compulsory savings accounts in the institution |
Clients | Definition |
Total number of clients | The total number of clients that have at least one outstanding loan and/or an open position (savings, deposits) |
Deliverables
Back end API code for impact portal (source code with comments and test cases)
Generating the datapoints listed above for clients, loans, savings
Writing the SQLs
Adding the APIs
Datapoints generated and cached in the DB for performance
Update API documentation and wiki page
How to use this new API endpoint for retrieving data
How to extend the number of datapoints
Impact Portal Front end (Source code)
User manual/ Documentation
Project Implementation Plan
Creating Impact Portal Front end
2. Back end user login for front end requests
3. Run report API changes for retrieve high level client details
4. Front End development to view user data
5. testing/documentation
Schedule/Timeline
Schedule upto mid term evaluation
Week # | Task | Description | Expected due date |
|---|---|---|---|
1 19.05.2014 to 26.05.2014 |
| After completing this task Run reports API will capable of generating reports regarding total number of clients that have at least one outstanding loan and/or an open position | 26.05.2014 |
2 26.05.2014 to 02.06.2014 | Writing SQL to generate voluntary Savings amount and Compulsory Savings amount and adding API | Run report API will be capable of creating reports for savings to get sum of the balances of all voluntary and compulsory savings after completing this task. | 02.06.2014 |
3 02.06.2014 to 09.06.2014 | Writing SQL to generate loan related reports listed above and adding to API | Run reports will be generated related to outstanding loans( number and principal), PAR 1% and PAR 30% | 09.06.2014 |
4 09.06.2014 to 16.06.2014 |
| Completing of previous weeks tasks and adding API documentation, DB caching to improve performance | 16.06.2014 |
5 16.06.2014 to 23.06.2014 | Finalizing all the back end run report API tasks and API documentation | By this week all the back end support for Client Impact Portal will be delivered | 23.06.2014 |