GSoC 2014 - Client Impact Portal

Target release
Epic
Source Code
Project StatusWORK IN PROGRESS
Document statusDRAFT
Document ownerChannaS
DesignerSander van der Heyden
DevelopersChannaS
QA

Project Summary

Goals

    • Implement back-end logic in MifosX required to make information available to the client impact portal
    • Implement UI and back-end logic of the Client impact portal

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.

LoansDescription
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 %
SavingsDefinition
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
ClientsDefinition
Total number of clientsThe total number of clients that have at least one outstanding loan and/or an open position (savings, deposits)

Deliverables

  1. Back end API code for impact portal (source code with comments and test cases)
    1. Generating the datapoints listed above for clients, loans, savings
      1. Writing the SQLs
      2. Adding the APIs
    2. Datapoints generated and cached in the DB for performance
  2. Update API documentation and wiki page
    1. How to use this new API endpoint for retrieving data
    2. How to extend the number of datapoints
  3. Impact Portal Front end (Source code)
  4. User manual/ Documentation 

Project Implementation Plan

  1. Creating Impact Portal Front end
    • Basic User log in windows/UI
    • Front end application storage/sql for user accounts

    2. Back end user login for front end requests
    3. Run report API changes for retrieve high level client details

    • Clients
    • Loans
    • Savings


   4. Front End development to view user data
   5. testing/documentation

 

 

 

Schedule/Timeline

Schedule upto mid term evaluation

Week #TaskDescriptionExpected due date

1

19.05.2014 to 26.05.2014

  • Writing SQL to retrieve total number of clients
  • Adding API 
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 position26.05.2014

2

26.05.2014 to 02.06.2014

Writing SQL to generate voluntary Savings amount and Compulsory Savings amount and adding APIRun 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

  • Datapoints creation and adding DB cache to improve performance.
  • API documentation and wiki page update regarding using/extending of new API endpoints

 

Completing of previous weeks tasks and adding API documentation, DB caching to improve performance16.06.2014

5

16.06.2014 to 23.06.2014

Finalizing all the back end run report API tasks and API documentationBy this week all the back end support for Client Impact Portal will be delivered 23.06.2014

 

Schedule from mid term to final evaluation. 

WeekTaskDescriptionExpected Due Date

30.06.2014 to

07.07.2014

Adding basic view components to home page

(for no of clients, loans, savings etc)

graphs, pie charts and other suitable components07.07.2014

07.07.2014 to

14.07.2014

adding database to store users and related tenants

with those users.

users with associated tenants.14.07.2014

14.07.2014 to

28.07.2014

adding user sign in/out with backend api callbasic authentication with backend.28.07.2014

28.07.2014 to

04.07.2014

adding backend data to portal components.(created datapoints

will be used to retrieve data)

backend front end connectivity for components in the front end04.07.2014

04.07.2014 to

11.07.2014

Documentation fine tuning and adding necessary changes. 11.07.2014

 

Additional Resources

Requirements

Assumptions

User Stories

#TitleUser StoryImportanceNotes
1
     

User interaction and design

Questions

Below is a list of questions to be addressed as a result of this requirements document:

QuestionOutcome

Not Doing

  •