/
PPI Functional Spec

PPI Functional Spec

Dec 21, 2010

Release

Leila E

Current Owners

Kay Chau

Status (Draft, In Review, Approved)

In Review

Contents:

Introduction

PPI as it is in Mifos is difficult to use and does not meet all the needs of an MFI who using PPI.  We need to implement the feature in Mifos so that it is more flexible, and provides the reporting capabilities to do analysis.  For Leila E, we must meet our Cisco commitments.

User Stories

Priority

User Stories

Section in FR

Priority

User Stories

Section in FR

P1

As a PPI Administrator at my MFI, I want to be able to access PPI surveys for my country when I am using Mifos.

3.1

P1

As a PPI Administrator at my MFI, I want to be able to activate one or more PPI's for my organization.

3.2

P1

As a PPI Administrator, I want to be able to apply Mifos PPI Surveys to more than one flow, and to be able to apply to multiple flows and modify the flows it applies to\

3.2

P1

As a Loan Officer, I want to be able to enter my clients' answers to PPI questions, and have them saved.

3.3

P1

As a Loan Officer, I want to be able to enter answers for PPI questions again (possibly in a different workflow), and have it saved as a separate survey.  I want to be able to track PPI score from survey to survey of the same client.

3.3

P1

As a Loan Officer, I want to be able to edit an answer that was entered (because of a mistake), and have reports take the latest version of that PPI Survey data since the old answer was incorrect

3.3

P1

As a PPI Administrator, I want to be able to select which version of PPI survey I want the Loan Officers at my MFI to fill out.

3.7

P1

As a PPI Administrator, I want to be able to inactivate one or more PPI's for my organization, but ensure that data saved against that survey is retained.

3.2

P1

As a PPI Administrator, when a PPI survey gets updated questions/answers, I want to ensure that the correct questions/answers are available.

3.6

P1

As a PPI Administrator, when a PPI survey gets updated points, I want to ensure existing surveys already taken get the right scores calculated.

3.6

P1

As a PPI Administrator, when a PPI survey gets an updated lookup table, I want to ensure new reports run display accurate data on likelihoods.

3.6

P2

As a PPI Administrator, I want to be able to run a "data dump" report to verify my clients' PPI scores

3.8

P2

As a PPI Administrator, I want to be able to run a "data dump" report to verify my clients' PPI likelihoods

3.8

Goals

  • Provide a way for MFI's to collect PPI survey data from clients entered into Mifos

    • When data is entered into Mifos, it is part of a workflow to collect information from clients

  • Ability to do analysis on scores and likelihoods of clients

    • 1 data dump will be available

  • Ability to select which PPI surveys are available for the MFI

Non-Goals

The following items will not be addressed in this release:

  • View clients' scores and likelihoods directly in Mifos (can be run in report)

  • Ability for anyone other than the Mifos product team to provide the PPI surveys in Mifos.

Definitions and Terminology

Term

Definitions

Term

Definitions

User

User of system



  • Mandatory fields will be preceded by "*" (an asterisk)

  • Links are italicized

  • Buttons are Button

Related Documents

Use Cases

Access PPI's

Actors

  • Administrator

Preconditions

  • Mifos is shipped with several PPI's

  • Mifos has been upgraded to version with this PPI.

Basic Flow

  • Administrator is able to view a directory of all shipped PPI's here - Past Releases. Administrator selects the one(s) relevant to their MFI, and copies it into the QG directory to be picked up.

Post-conditions

  • Under Activate QG, the dropdown includes the PPI's the Administrator has copied over.

Activate India PPI

Actors

  • Administrator

Preconditions

  • Mifos is shipped with India PPI 2005.

  • Mifos has been upgraded to version with this PPI.

  • Mifos Administrator has copied the PPI India 2005 manually to the correct directory (part of Upgrade notes)

Basic Flow

  • Administrator navigates to Activate Question Groups in Admin section of Mifos.

  • Administrator is able to select "India PPI Survey 2005" from a list of available QG's and chooses to activate.

  • Mifos activates "India PPI Survey 2005".

Post-conditions

  • Under "View Question Groups" will be a QG called "India PPI Survey 2005" with the questions and answer choices.  The survey is automatically assigned to the Create Client workflow.

  • When a Loan Officer enters in clients' answers to a PPI, he is able to select India PPI 2005 as the version he wants to enter.

Change where the PPI questions are asked

PPI Administrator wants the PPI questions to be asked during Close Client, not Create Client

  • Administrator navigates to View Question Groups, and selects PPI India 2005.

  • Administrator edits the QG, and edits the Applies To: to be Close Client, and removes Create Client.  Administrator saves the new QG.

OR

  • Mifos Administrator changes the PPI India 2005 XML file directly to have Close Client instead of Create Client as the <applies to> tag.  Administrator restarts Mifos.

  • Mifos Administrator logs onto Mifos, and follows the Activate PPI Survey and activates the new survey.  They also inactivate the old one.

Post-conditions

  • The PPI Survey is now available only when a client's status is being changed to Closed.  It is not displayed during Client Creation.

Have PPI questions asked in more than one flow

PPI Administrator wants the PPI questions to be asked during both Create Client, and when opening a new Loan account for the client.

  • Administrator navigates to View Question Groups, and selects PPI India 2005.

  • Administrator edits the QG, and edits the Applies To: to be Create Client and Create Loan.  Administrator saves the QG.

Post-conditions

  • The PPI Survey is now available during Client Creation and Loan Creation.

Inactivate PPI

A new survey has come out, and the Administrator needs to inactivate the old one

  • Administrator navigates to View Question Groups, and selects the old Survey.

  • Administrator edits the QG, and chooses to make it Inactive.  Administrator saves the QG.

Post-conditions

  • The old survey is now inactive.  It does not appear anywhere in Mifos.

  • For clients who had used the old survey, it is still possible to run reports based on the old survey.

Validations

Save PPI Answers

Actors

  • Loan Officer

Preconditions

  • PPI India 2005 has been activated and applied to the Create Client workflow.

Basic Flow

  • Loan Officer navigates to create a new client, and under Additional Information, the PPI Survey questions are displayed. Loan Officer selects the right answer choices and saves the client information.

Post-conditions

  • Client has PPI Survey data saved, and the data is ready for reporting.

Save another set of PPI Answers

Actors

  • Loan Officer

Preconditions

  • PPI India 2005 has been applied to both Create Client and Close Client workflows. Client's PPI data was collected during client creation.

Basic Flow

  • Client is leaving the MFI. Loan Officer would like to conduct an exit survey. Loan Officer navigates to Close the Client, and PPI Questions are displayed. Loan Officer saves the latest answers.

Post-conditions

  • Report can be run to take both PPI scores from Client creation and Close Client. The scores are separate and accurate.

Update Incorrect Answers Captured with a PPI Survey

Actors

  • Loan Officer

Preconditions

  • PPI India 2005 has been filled out for a client. One of the answers captured was incorrect.

Basic Flow

  • Loan Officer navigates to where the wrong answer was captured for the client. Loan Officer is able to view the answers already captured, and clicks on Edit to edit the answers.

  • Loan Officer saves the correct answers.

Post-conditions

  • Reports only take the latest version of this data saved. Old data is retained but is not used for reporting the score.

Update Incorrect Questions/Answer Choices with a specific PPI Survey Version

Example:  PPI India Survey 2005 was published, and is shipped with Mifos.  However, a couple of months later, it turns out one of the questions and/or answer choices was incorrect and needs to be updated.

Actors

  • PPI Administrator

Basic Flow

  • Mifos Team updates the PPI India Survey 2005 QG that was shipped with Mifos with a new version with new question/answers.

  • Mifos is upgraded at the MFI.

  • Mifos Administrator locates the new XML file with the updated Survey questions and answer choices, and copies to the QG directory for activation.

  • Administrator navigates to View Question Groups, and inactivates the old QG with the incorrect questions and/or answers.

  • Administrator then navigates to Activate QG and activates the new India PPI 2005. (Is there an indicator that this is different?)

  • Administrator navigates to View Question Groups again, and edits the new PPI Survey to have all the properties he wants (workflows to apply to, editable answers, etc)

Post-conditions

  • Loan Officer can now see updated survey questions and/or answers for entering PPI surveys.

  • Old surveys need to be invalidated?

Update Incorrect Answers' Point Values with a specific PPI Survey Version

Example:  PPI India Survey 2005 was published, and is shipped with Mifos.  However, a couple of months later, it turns out one of the points associated with an answer choice was incorrect.  The Scoring associated with the survey needs to be updated to reflect this.

Actors

  • PPI Administrator

Basic Flow

  • Mifos Team updates the Mifos PPI Scoring and Likelihood Lookup Tool with the NEW scoring.  Mifos BI is updated and released.

  • Mifos BI is upgraded at the MFI.

  • PPI continues to be collected.

Post-conditions

  • All reports run on surveys taken with this particular version, should now use the new Scoring to calculate score.

  • No changes to UI

Update Incorrect Lookup Table(s) with a specific PPI Survey Version

Example:  PPI India Survey 2005 was published, and is shipped with Mifos.  However, a couple of months later, it turns out the lookup table was INCORRECT for the NPL.  The values need to be updated.

Actors

  • PPI Administrator

Basic Flow

  • Mifos Team updates the Mifos PPI Scoring and Likelihood Lookup Tool with the NEW Lookup tables.  Mifos BI is updated and released.

  • Mifos BI is upgraded at the MFI.

  • PPI continues to be collected.

Post-conditions

  • All reports run on surveys taken with this particular version, should now have the updated likelihood data.

  • No changes to UI

Update NEW PPI Survey version

Example:  PPI India Survey 2005 was published, and is shipped with Mifos.  In 2007, a new PPI India Survey comes out.  It can have different questions, answers, scoring, and/or lookup tables.  These all need to be updated.  However, all surveys taken before 2007 should still use old Scoring and Lookup Tables.

Actors

  • PPI Administrator


Basic Flow

  • Mifos Team delivers new PPI India Survey 2007 with updated Survey questions and answers, Scoring, and/or Lookup Tables.

  • Mifos and Mifos BI is upgraded at the MFI.

  • PPI Administrator follows the Access PPI's and then Activate PPI use case and activates PPI India Survey 2007.  They also inactivate PPI India Survey 2005.

Post-conditions

  • Reports run should map to correct survey version date.  If a report is run from 2005 to 2009, for likelihoods under $1/day, and that band is not available in 2005, then the report should throw an error.

  • No changes to UI

View PPI Score and Likelihoods

Actors

  • PPI Administrator

Basic Flow

  • PPI Administrator logs onto Pentaho, and selects to run PPI Data Dump Report.

  • PPI Administrator selects the dates to run the data dump for, and runs the Report.

  • Data Dump Report in Excel is displayed.  

Post-conditions

Functional Requirements

Pre-shipped PPI Surveys

FR #

Pri

Description

Comments/Mockups

FR #

Pri

Description

Comments/Mockups

1.1

P1

Mifos will ship with a set of XML files that are the latest PPI surveys for each country available.  These are in the Mifos Question Group format.

Mifos will ship with all countries available.


1.2

P1

See XML template here -

 

1.3

P1

Each file will have survey questions and answer choices associated with the PPI Survey.

Bug fixed to allow longer question titles

1.4

P1

In addition, there will also be a field to enter the Date of Survey Taken.

 

1.5

P1

Each survey is also by default applied to the "Create Client" workflow.

 

Activate PPI

FR #

Pri

Description

Comments/Mockups

FR #

Pri

Description

Comments/Mockups

2.1

P1

PPI Surveys are not active by default.  Mifos Administrator must copy the relevant PPI survey files and place them in the QG directory in Mifos in order for them to be available for activation.


2.2

P1

Administrator can navigate to Activate Question Group link and view a dropdown of Question Groups available.  PPI Surveys will be prefixed with "PPI".  All PPI surveys available will be listed. 

 

2.3

P1

Administrator can choose a PPI Survey they want to activate, and click Submit. 

 

2.4

P1

Afterward, Administrator can view the QG is available in "View Question Groups".  Once it is activated, the PPI Survey is active and automatically in the Create Client workflow.

 

2.5

P1

Administrator can edit a PPI Survey QG to change and update multiple workflows the PPI Survey applies to. 

The only workflows that will generate a PPI Score are the following:

Create Client
View Client
Close Client
Create Loan
View Loan
Approve Loan
Create Savings
View Savings

 

2.6

P1

Administrator can change the order of questions asked in a PPI Survey.  This has no effect on the score.