-
Notifications
You must be signed in to change notification settings - Fork 4
docs(config_guide): add graduation guides and update scoring #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
emjay0921
wants to merge
2
commits into
v2-in-progress-3
Choose a base branch
from
fix/config-guide-822-program-config
base: v2-in-progress-3
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+73 KB
docs/_images/en-us/config_guide/graduation/01-graduation-pathways-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+119 KB
docs/_images/en-us/config_guide/graduation/02-graduation-pathway-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| openspp: | ||
| doc_status: draft | ||
| products: [core] | ||
| --- | ||
|
|
||
| # Graduation criteria | ||
|
|
||
| This guide is for **implementers** defining the conditions beneficiaries must meet for program graduation. | ||
|
|
||
| ## Criteria configuration | ||
|
|
||
| Each criterion within a pathway has: | ||
|
|
||
| | Field | What it means | | ||
| |-------|---------------| | ||
| | **Name** | Criterion label (e.g., "Income Threshold") | | ||
| | **Pathway** | Which graduation pathway this belongs to | | ||
| | **Weight** | Importance (default 1.0, higher = more important) | | ||
| | **Assessment Method** | How the criterion is verified | | ||
| | **Required** | Must be met for graduation (vs. optional) | | ||
|
|
||
| ### Assessment methods | ||
|
|
||
| | Method | How it works | Best for | | ||
| |--------|-------------|----------| | ||
| | **Self-report** | Beneficiary provides information | Income, savings, livelihood status | | ||
| | **Verification Required** | Third-party or document verification | Employment, bank account, asset ownership | | ||
| | **Computed** | System calculates from data | Program attendance, payment history | | ||
| | **Field Observation** | Case worker observes during visit | Housing quality, livelihood activity | | ||
|
|
||
| ### Pre-configured criteria examples | ||
|
|
||
| | Criterion | Method | Weight | Description | | ||
| |-----------|--------|--------|-------------| | ||
| | Income threshold | Verification Required | 1.0 | Monthly income above poverty line | | ||
| | Livelihood activity | Field Observation | 1.0 | Has active income-generating activity | | ||
| | Savings account | Verification Required | 0.8 | Has functional savings account | | ||
| | Training completion | Computed | 0.6 | Completed required training sessions | | ||
| | Debt level | Self-report | 0.5 | Manageable debt-to-income ratio | | ||
|
|
||
| ## Setting up criteria | ||
|
|
||
| ### Step 1: Plan your graduation conditions | ||
|
|
||
| Determine what beneficiaries must achieve: | ||
| - Which criteria are mandatory vs. optional? | ||
| - How will each criterion be verified? | ||
| - What weights reflect your program's priorities? | ||
|
|
||
| ### Step 2: Create criteria | ||
|
|
||
| 1. Navigate to **Graduation > Graduation Criteria** | ||
| 2. Click **Create** | ||
| 3. Select the **Pathway** | ||
| 4. Set the **Name**, **Weight**, and **Assessment Method** | ||
| 5. Mark as **Required** if mandatory | ||
| 6. Save | ||
|
|
||
| ### Step 3: Run assessments | ||
|
|
||
| 1. Open a beneficiary's graduation assessment | ||
| 2. For each criterion, record whether it is met | ||
| 3. The system calculates an overall readiness score based on weights | ||
| 4. If all required criteria are met, the beneficiary is eligible for graduation | ||
|
|
||
| ## Monitoring duration | ||
|
|
||
| After graduation, beneficiaries enter a monitoring period: | ||
|
|
||
| | Setting | What it means | | ||
| |---------|-------------| | ||
| | **Monitoring Duration (months)** | How long to track post-graduation | | ||
|
|
||
| During monitoring: | ||
| - The system continues tracking the graduated beneficiary | ||
| - If key indicators fall below thresholds, they can be flagged for re-enrollment | ||
| - At the end of monitoring, the graduation is confirmed as final | ||
|
|
||
| ## Are You Stuck? | ||
|
|
||
| **Criteria weights - how are they used?** | ||
|
|
||
| Weights contribute to an overall graduation readiness score. A criterion with weight 1.0 has twice the impact of one with weight 0.5. The exact threshold for "ready to graduate" depends on your program policy. | ||
|
|
||
| **Can I have different criteria for different pathways?** | ||
|
|
||
| Yes. Each criterion is linked to a specific pathway. Standard Graduation might require 5 criteria while Early Graduation requires 3. | ||
|
|
||
| **How do I handle computed criteria?** | ||
|
|
||
| Computed criteria pull data from the system automatically (e.g., attendance records, payment history). The computation is based on existing program data. | ||
|
|
||
| **Beneficiary meets criteria but supervisor disagrees?** | ||
|
|
||
| If the pathway has **Approval Required** enabled, the supervisor can reject the graduation even if criteria are met, with a documented reason. | ||
|
|
||
| ## Next steps | ||
|
|
||
| - {doc}`overview` - Graduation pathway fundamentals | ||
| - {doc}`/config_guide/scoring/overview` - Use scoring models for graduation assessment | ||
| - {doc}`/config_guide/session_tracking/overview` - Track training completion for criteria |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| openspp: | ||
| doc_status: draft | ||
| products: [core] | ||
| --- | ||
|
|
||
| # Graduation | ||
|
|
||
| This guide is for **implementers** configuring program exit pathways, graduation criteria, and assessment processes for time-bound social protection programs. | ||
|
|
||
| ## What you'll find here | ||
|
|
||
| - **{doc}`overview`** - Graduation concepts, pathways, and navigation | ||
| - **{doc}`criteria`** - Assessment criteria, weights, methods, and monitoring | ||
|
|
||
| ```{toctree} | ||
| :hidden: | ||
| :maxdepth: 1 | ||
|
|
||
| overview | ||
| criteria | ||
| ``` | ||
|
|
||
| ## Quick start | ||
|
|
||
| 1. Navigate to **Graduation > Graduation Pathways** | ||
| 2. Create **Pathways** for each exit type (e.g., Standard Graduation, Early Exit, Administrative Exit) | ||
| 3. Define **Criteria** for each pathway (e.g., income threshold, savings account) | ||
| 4. Configure assessment requirements and monitoring duration |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| --- | ||
| openspp: | ||
| doc_status: draft | ||
| products: [core] | ||
| --- | ||
|
|
||
| # Graduation overview | ||
|
|
||
| This guide is for **implementers** configuring program exit pathways in OpenSPP. You should understand your program's graduation policy but don't need programming knowledge. | ||
|
|
||
| ## Mental model | ||
|
|
||
| Graduation in OpenSPP has three layers: | ||
|
|
||
| | Layer | What it does | Example | | ||
| |-------|--------------|---------| | ||
| | **Pathway** | Defines the type of exit | "Standard Graduation" (positive), "Administrative Exit" (neutral) | | ||
| | **Criteria** | Conditions that must be met | "Monthly income > $200", "Has savings account" | | ||
| | **Assessment** | Individual evaluation against criteria | "Maria meets 4/5 criteria - ready for graduation" | | ||
|
|
||
| Think of it like a school graduation: **pathways** are the degree programs (with honors, standard, early exit), **criteria** are the course requirements, and **assessments** are the final exams. | ||
|
|
||
| ## Key concepts | ||
|
|
||
| ### Graduation pathways | ||
|
|
||
| | Field | What it means | | ||
| |-------|---------------| | ||
| | **Name** | Pathway label (e.g., "Standard Graduation") | | ||
| | **Exit Type** | Positive or Negative | | ||
| | **Assessment Required** | Whether formal assessment is needed before exit | | ||
| | **Approval Required** | Whether graduation needs supervisor approval | | ||
| | **Monitoring Duration** | Months of post-graduation monitoring | | ||
|
|
||
| #### Exit types | ||
|
|
||
| | Type | Meaning | Example | | ||
| |------|---------|---------| | ||
| | **Positive** | Beneficiary achieved program goals | Completed training, above poverty line | | ||
| | **Negative** | Exit without achieving goals | Relocated, deceased, administrative removal | | ||
|
|
||
| ### Pre-configured pathways | ||
|
|
||
| ```{figure} /_images/en-us/config_guide/graduation/02-graduation-pathway-form.png | ||
| :alt: Graduation pathway form showing criteria, assessment methods, and weights | ||
| Graduation pathway form showing criteria, assessment methods, and weights. | ||
| ``` | ||
|
|
||
| OpenSPP includes three default pathways: | ||
|
|
||
| | Pathway | Exit Type | Assessment | Approval | | ||
| |---------|-----------|-----------|----------| | ||
| | Standard Graduation | Positive | Yes | Yes | | ||
| | Early Graduation | Positive | Yes | Yes | | ||
| | Administrative Exit | Negative | No | No | | ||
|
|
||
| ## Navigation | ||
|
|
||
| | Menu | Purpose | | ||
| |------|---------| | ||
| | **Graduation > Graduation Pathways** | Define exit pathways | | ||
| | **Graduation > Graduation Criteria** | Configure assessment criteria | | ||
| | **Graduation > Assessments** | View individual assessments | | ||
|
|
||
| ```{figure} /_images/en-us/config_guide/graduation/01-graduation-pathways-list.png | ||
| :alt: Graduation pathways list showing exit type and assessment requirements | ||
| Graduation pathways list showing exit type and assessment requirements. | ||
| ``` | ||
|
|
||
| ## Common use cases | ||
|
|
||
| ### Use case 1: Poverty graduation program | ||
|
|
||
| **Goal:** Graduate beneficiaries who achieve economic self-sufficiency. | ||
|
|
||
| **Setup:** | ||
| 1. Use the "Standard Graduation" pathway | ||
| 2. Set criteria: income threshold, savings, livelihood activity | ||
| 3. Require assessment and supervisor approval | ||
| 4. Set 6-month post-graduation monitoring | ||
|
|
||
| ### Use case 2: Emergency program exit | ||
|
|
||
| **Goal:** Administrative exit when emergency response concludes. | ||
|
|
||
| **Setup:** | ||
| 1. Use the "Administrative Exit" pathway | ||
| 2. No assessment or approval required | ||
| 3. Set 0 months monitoring | ||
| 4. Bulk-process exits for all remaining beneficiaries | ||
|
|
||
| ## Are You Stuck? | ||
|
|
||
| **Where do I configure graduation?** | ||
|
|
||
| Navigate to **Graduation** in the main menu. If you don't see it, ask your administrator to install the **Graduation** module. | ||
|
|
||
| **What happens during post-graduation monitoring?** | ||
|
|
||
| The system tracks graduated beneficiaries for the configured duration. This allows re-enrollment if they fall back below thresholds. | ||
|
|
||
| **Can I customize the default pathways?** | ||
|
|
||
| Yes. Edit or create new pathways to match your program's exit policies. | ||
|
|
||
| ## Next steps | ||
|
|
||
| - {doc}`criteria` - Configure assessment criteria | ||
| - {doc}`/config_guide/eligibility/index` - Connect graduation to eligibility rules | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| --- | ||
| orphan: true | ||
| openspp: | ||
| doc_status: draft | ||
| products: [core] | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The term "neutral" is used here to describe the "Administrative Exit" pathway, but the "Exit Type" field is defined as having only "Positive" or "Negative" values (line 30). Furthermore, the tables on lines 40 and 55 explicitly categorize "Administrative Exit" as "Negative". For consistency and to align with the defined field values, this should be updated to "Negative" (and "positive" to "Positive").