Target release	Release name or number
Epic	Link to related JIRA epic or feature
Source Code	Link to GitHub Repository
Project Status
Document status
Document owner	ChannaS
Designer	Sander van der Heyden
Developers	ChannaS
QA	Lead tester

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.

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)
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
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
Impact Portal Front end (Source code)
User manual/ Documentation

Project Implementation Plan

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

High level schedule for implementation based on GSOC calendar

Additional Resources

Link to background, wiki pages, other similar work, research related to the project.

Requirements

Assumptions

List the assumptions you have such as user, technical or other business assumptions. (e.g. users will primarily access this feature from a tablet).

User Stories

#	Title	User Story	Importance	Notes
1	Short identifier for the story	Describe the user and what they are trying to achieve	Must Have	Additional considerations or noteworthy references (links, issues)

User interaction and design

Include any mockups, diagrams or visual designs relating to these requirements.

Questions

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

Question	Outcome
(e.g. How we make users more aware of this feature?)	Communicate the decision reached

Not Doing

List the features discussed which are out of scope or might be revisited in a later release.