diff --git a/docs/_images/en-us/get_started/explore/cle1_1.png b/docs/_images/en-us/get_started/explore/cle1_1.png new file mode 100644 index 00000000..3af37e3f Binary files /dev/null and b/docs/_images/en-us/get_started/explore/cle1_1.png differ diff --git a/docs/_images/en-us/get_started/explore/cle1_2.png b/docs/_images/en-us/get_started/explore/cle1_2.png new file mode 100644 index 00000000..b073b5fb Binary files /dev/null and b/docs/_images/en-us/get_started/explore/cle1_2.png differ diff --git a/docs/_images/en-us/get_started/explore/cle1_3.png b/docs/_images/en-us/get_started/explore/cle1_3.png new file mode 100644 index 00000000..7d1913d9 Binary files /dev/null and b/docs/_images/en-us/get_started/explore/cle1_3.png differ diff --git a/docs/_images/en-us/get_started/explore/cle1_4.png b/docs/_images/en-us/get_started/explore/cle1_4.png new file mode 100644 index 00000000..fcb37b25 Binary files /dev/null and b/docs/_images/en-us/get_started/explore/cle1_4.png differ diff --git a/docs/_images/en-us/get_started/explore/cle1_5.png b/docs/_images/en-us/get_started/explore/cle1_5.png new file mode 100644 index 00000000..6baade31 Binary files /dev/null and b/docs/_images/en-us/get_started/explore/cle1_5.png differ diff --git a/docs/_images/en-us/get_started/first_household/01_access_registry/cle2_1.png b/docs/_images/en-us/get_started/first_household/01_access_registry/cle2_1.png new file mode 100644 index 00000000..6535551e Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/01_access_registry/cle2_1.png differ diff --git a/docs/_images/en-us/get_started/first_household/01_access_registry/cle2_2.png b/docs/_images/en-us/get_started/first_household/01_access_registry/cle2_2.png new file mode 100644 index 00000000..5de0d7aa Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/01_access_registry/cle2_2.png differ diff --git a/docs/_images/en-us/get_started/first_household/02_create_household/cle3_1.png b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_1.png new file mode 100644 index 00000000..3708da87 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_1.png differ diff --git a/docs/_images/en-us/get_started/first_household/02_create_household/cle3_2.png b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_2.png new file mode 100644 index 00000000..8856c81b Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_2.png differ diff --git a/docs/_images/en-us/get_started/first_household/02_create_household/cle3_3.png b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_3.png new file mode 100644 index 00000000..b1695ad9 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_3.png differ diff --git a/docs/_images/en-us/get_started/first_household/02_create_household/cle3_4.png b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_4.png new file mode 100644 index 00000000..8aa095ea Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/02_create_household/cle3_4.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_1.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_1.png new file mode 100644 index 00000000..dd241464 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_1.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_2.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_2.png new file mode 100644 index 00000000..f3524dda Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_2.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_3.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_3.png new file mode 100644 index 00000000..d4545b10 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_3.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_4.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_4.png new file mode 100644 index 00000000..51054cc6 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_4.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_5.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_5.png new file mode 100644 index 00000000..10d52eb8 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_5.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_6.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_6.png new file mode 100644 index 00000000..b52f1d61 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_6.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_7.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_7.png new file mode 100644 index 00000000..d1bb7349 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_7.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_8.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_8.png new file mode 100644 index 00000000..9e943ac9 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_8.png differ diff --git a/docs/_images/en-us/get_started/first_household/03_add_members/cle4_9.png b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_9.png new file mode 100644 index 00000000..34199d28 Binary files /dev/null and b/docs/_images/en-us/get_started/first_household/03_add_members/cle4_9.png differ diff --git a/docs/_images/en-us/get_started/first_program/03_create_program/cle5_1.png b/docs/_images/en-us/get_started/first_program/03_create_program/cle5_1.png new file mode 100644 index 00000000..9776e0c9 Binary files /dev/null and b/docs/_images/en-us/get_started/first_program/03_create_program/cle5_1.png differ diff --git a/docs/_images/en-us/get_started/first_program/03_create_program/cle5_2.png b/docs/_images/en-us/get_started/first_program/03_create_program/cle5_2.png new file mode 100644 index 00000000..7d606e60 Binary files /dev/null and b/docs/_images/en-us/get_started/first_program/03_create_program/cle5_2.png differ diff --git a/docs/get_started/explore/index.md b/docs/get_started/explore/index.md index 20f890ae..51ab749d 100644 --- a/docs/get_started/explore/index.md +++ b/docs/get_started/explore/index.md @@ -12,7 +12,7 @@ Load sample data to explore OpenSPP features before starting tutorials. Before diving into the tutorials, you'll need sample data to work with. This guide walks you through loading demo data that includes sample households, individuals, and programs. -## What You'll Get +## What you'll get After loading the MIS demo data, you'll have: @@ -23,61 +23,62 @@ After loading the MIS demo data, you'll have: - **Logic Packs** - Pre-configured eligibility rules - **Change requests** - At various workflow stages -## Before You Start +## Before you start - OpenSPP should be installed and running (see {doc}`../installation/index`) +- OpenSPP SPMIS Demo should be installed - You need administrator access to OpenSPP -## Load Demo Data +## Load demo data -### Step 1: Log in as Administrator +### Step 1: Log in as administrator Log in to OpenSPP using administrator credentials (default: admin/admin). -![Screenshot: Dashboard after login](/_images/en-us/get_started/explore/1.png) +![Screenshot: Dashboard after login](/_images/en-us/get_started/explore/cle1_1.png) ### Step 2: Open Settings Click **Settings** in the left sidebar. -![Screenshot: Settings page](/_images/en-us/get_started/explore/2.png) +![Screenshot: Settings page](/_images/en-us/get_started/explore/cle1_2.png) -### Step 3: Navigate to Demo Data +### Step 3: Navigate to demo data In the Settings top menu, click **Demo Data** > **Load MIS Demo**. -![Screenshot: Settings with Demo Data menu](/_images/en-us/get_started/explore/3.png) +![Screenshot: Settings with Demo Data menu](/_images/en-us/get_started/explore/cle1_3.png) -### Step 4: Open the Wizard +### Step 4: Open the wizard The Load MIS Demo wizard opens in a dialog. -![Screenshot: Wizard opening](/_images/en-us/get_started/explore/4.png) +![Screenshot: Wizard opening](/_images/en-us/get_started/explore/cle1_4.png) -### Step 5: Generate Demo Data +### Step 5: Generate demo data -Review the configuration options and click **Generate Demo Data** to start. +Review the configuration options and click **Load Demo Data** to start. -![Screenshot: Generate MIS Demo Data wizard](/_images/en-us/get_started/explore/5.png) +![Screenshot: Generate MIS Demo Data wizard](/_images/en-us/get_started/explore/cle1_5.png) ```{note} Demo data generation takes 2-5 minutes depending on your system. The wizard will redirect you to the Programs page when complete. ``` -## What's Included +## What's included -### Sample Programs +### Sample programs -| Program | Description | -| ------------------ | ------------------------------------------------ | -| Child Grant | Monthly cash transfer for families with children | -| Pension | Social pension for elderly citizens | -| Emergency Relief | One-time emergency assistance | -| Cash Transfer | General cash transfer program | -| Disability Support | Assistance for persons with disabilities | -| Food Assistance | Food voucher program | +| Program | Description | +| ------------------------ | ------------------------------------------------ | +| Food Assistance | Food voucher program | +| Disability Support Grant | Assistance for persons with disabilities | +| Cash Transfer Program | General cash transfer program | +| Emergency Relief Fund | One-time emergency assistance | +| Elderly Social Pension | Social pension for elderly citizens | +| Universal Child Grant | Monthly cash transfer for families with children | -### Demo Personas +### Demo personas The demo includes 8 complete registrant stories: @@ -86,15 +87,17 @@ The demo includes 8 complete registrant stories: - Payment history and entitlement records - Change requests at various workflow stages -### Demo Users +### Demo users -| User | Role | Password | -| ------------ | ---------------- | -------- | -| demo_admin | Administrator | demo | -| demo_manager | Program Manager | demo | -| demo_officer | Registry Officer | demo | +| User | Role | Password | +| --------------- | ---------------- | -------- | +| demo_manager. | Program Manager | demo | +| demo_officer | Registry Officer | demo | +| demo_supervisor | Supervisor | demo | +| demo_viewer | Viewer | demo | -## Are You Stuck? + +## Are you stuck? **Can't find Settings menu?** Make sure you're logged in as an administrator. Regular users don't have access to system settings. diff --git a/docs/get_started/first_household/01_access_registry.md b/docs/get_started/first_household/01_access_registry.md index e3041fa0..32166fa8 100644 --- a/docs/get_started/first_household/01_access_registry.md +++ b/docs/get_started/first_household/01_access_registry.md @@ -8,17 +8,17 @@ openspp: This tutorial is for **users** who are new to OpenSPP and want to learn how to access the beneficiary registry. -## What You'll Do +## What you'll do Learn how to navigate to the Registry module and understand the Registry Search Portal - the central interface for managing registrants in OpenSPP. -## Before You Start +## Before you start - You need access to OpenSPP with Registry Officer or Administrator permissions - OpenSPP should be installed and running - Allow 2-3 minutes to complete this step -## The Scenario +## The scenario You're a registry officer who needs to register a new household in the system. The Garcia family has arrived at your office to enroll in social protection programs. First, you need to access the registry to create their records. @@ -28,13 +28,13 @@ You're a registry officer who needs to register a new household in the system. T After logging in to OpenSPP, you'll see the sidebar menu on the left. Click **Registry** to access the beneficiary management portal. -![Screenshot: Sidebar showing Registry option](/_images/en-us/get_started/first_household/01_access_registry/1.png) +![Screenshot: Sidebar showing Registry option](/_images/en-us/get_started/first_household/01_access_registry/cle2_1.png) ### 2. Explore the Registry Search Portal The Registry Search Portal is the main interface for managing registrants. It provides a privacy-first approach where you search for records rather than browsing lists. -![Screenshot: Registry Search Portal overview](/_images/en-us/get_started/first_household/01_access_registry/2.png) +![Screenshot: Registry Search Portal overview](/_images/en-us/get_started/first_household/01_access_registry/cle2_2.png) Key elements of the interface: @@ -56,7 +56,7 @@ In OpenSPP: You'll create registrants first. They become beneficiaries only after enrollment in a program. -## What You Accomplished +## What you accomplished You've learned how to: @@ -64,7 +64,7 @@ You've learned how to: - Navigate to the Registry Search Portal - Understand the key interface elements -## Are You Stuck? +## Are you stuck? **Can't find Registry in the sidebar?** Make sure you're logged in with appropriate permissions. Ask your system administrator to grant you access to the Registry module. @@ -73,5 +73,4 @@ Make sure you're logged in with appropriate permissions. Ask your system adminis You may not have permission to create new records. Contact your administrator to grant you the appropriate access rights. ## Next Step - Now that you understand the registry interface, you're ready to create your first household. Continue to [Step 2: Create a Household](02_create_household.md). diff --git a/docs/get_started/first_household/02_create_household.md b/docs/get_started/first_household/02_create_household.md index ffae85ad..0dd35936 100644 --- a/docs/get_started/first_household/02_create_household.md +++ b/docs/get_started/first_household/02_create_household.md @@ -6,19 +6,19 @@ openspp: # Step 2: Create a Household -This tutorial is for **users** who need to register a new household in OpenSPP. +This tutorial is for **users** who want to register a new household in OpenSPP. -## What You'll Do +## What you'll do -Create a new household (group) record in the registry, entering basic information about the family unit. +Create a new household (group) record in the registry, entering basic information about the family. -## Before You Start +## Before you start - Complete [Step 1: Access the Registry](01_access_registry.md) - Have information about the household to register (name, address, contact details) - Allow 3-5 minutes to complete this step -## The Scenario +## The scenario The Garcia family has come to your office. You need to create a household record for them before adding individual family members. @@ -28,9 +28,9 @@ The Garcia family has come to your office. You need to create a household record From the Registry Search Portal, click the **New Group** button. -![Screenshot: Click New Group button](/_images/en-us/get_started/first_household/02_create_household/1.png) +![Screenshot: Click New Group button](/_images/en-us/get_started/first_household/02_create_household/cle3_1.png) -### 2. Enter Household Information +### 2. Enter household information The group form opens. Enter the required information: @@ -41,21 +41,21 @@ The group form opens. Enter the required information: | Address | 123 Main Street | Physical address | | Phone | +1-555-0123 | Contact number | -![Screenshot: Group form with fields filled in](/_images/en-us/get_started/first_household/02_create_household/2.png) +![Screenshot: Group form with fields filled in](/_images/en-us/get_started/first_household/02_create_household/cle3_2.png) -### 3. Save the Household +### 3. Save the household Click **Save** to create the household record. -![Screenshot: Save button highlighted](/_images/en-us/get_started/first_household/02_create_household/3.png) +![Screenshot: Save button highlighted](/_images/en-us/get_started/first_household/02_create_household/cle3_3.png) -### 4. Verify Creation +### 4. Verify creation After saving, you'll see the household record. Notice the household has no members yet - you'll add them in the next step. -![Screenshot: Saved household record showing empty members section](/_images/en-us/get_started/first_household/02_create_household/4.png) +![Screenshot: Saved household record showing empty members section](/_images/en-us/get_started/first_household/02_create_household/cle3_4.png) -## What You Accomplished +## What you accomplished You've learned how to: @@ -63,7 +63,7 @@ You've learned how to: - Enter basic household information - Save and verify the household record -## Key Concepts +## Key concepts | Concept | Description | |---------|-------------| @@ -71,7 +71,7 @@ You've learned how to: | **Kind** | The type of group (Household, Organization, etc.) | | **Members** | Individuals who belong to the group | -## Are You Stuck? +## Are you stuck? **Required field missing?** Required fields depend on your system configuration. Contact your administrator if a field you need isn't available. @@ -83,5 +83,4 @@ Check that all required fields are filled in. Required fields typically have an Your administrator may need to configure group types for your installation. ## Next Step - Now that you've created the household, you're ready to add family members. Continue to [Step 3: Add Members](03_add_members.md). diff --git a/docs/get_started/first_household/03_add_members.md b/docs/get_started/first_household/03_add_members.md index 36432a1c..6921db11 100644 --- a/docs/get_started/first_household/03_add_members.md +++ b/docs/get_started/first_household/03_add_members.md @@ -4,21 +4,21 @@ openspp: products: [registry, programs] --- -# Step 3: Add Members +# Step 3: Add members This tutorial is for **users** who need to add individual family members to a household. -## What You'll Do +## What you'll do Create individual records for family members and link them to the household you created in Step 2. -## Before You Start +## Before you start - Complete [Step 2: Create a Household](02_create_household.md) - Have information about each family member (names, dates of birth, etc.) - Allow 5-10 minutes to complete this step -## The Scenario +## The scenario You've created the Garcia Family household. Now you need to register the individual family members: Maria (head of household), Carlos (spouse), and Sofia (child). @@ -28,9 +28,9 @@ You've created the Garcia Family household. Now you need to register the individ From the Registry Search Portal, click **New Individual** to create the first family member. -![Screenshot: Click New Individual button](/_images/en-us/get_started/first_household/03_add_members/1.png) +![Screenshot: Click New Individual button](/_images/en-us/get_started/first_household/03_add_members/cle4_1.png) -### 2. Enter Individual Information +### 2. Enter individual information Enter the information for Maria Garcia, the head of household: @@ -42,13 +42,13 @@ Enter the information for Maria Garcia, the head of household: | Gender | Female | | Phone | +1-555-0123 | -![Screenshot: Individual form filled in for Maria](/_images/en-us/get_started/first_household/03_add_members/2.png) +![Screenshot: Individual form filled in for Maria](/_images/en-us/get_started/first_household/03_add_members/cle4_2.png) ### 3. Save the Individual Click **Save** to create Maria's record. -![Screenshot: Saved individual record](/_images/en-us/get_started/first_household/03_add_members/3.png) +![Screenshot: Saved individual record](/_images/en-us/get_started/first_household/03_add_members/cle4_3.png) ### 4. Create Additional Family Members @@ -72,49 +72,43 @@ Repeat steps 1-3 to create records for: | Date of Birth | 2020-01-10 | | Gender | Female | -### 5. Open the Household Record +### 5. Open the household record Search for "Garcia Family" in the Registry Search Portal and open the household record. -![Screenshot: Search for Garcia Family](/_images/en-us/get_started/first_household/03_add_members/4.png) +![Screenshot: Search for Garcia Family](/_images/en-us/get_started/first_household/03_add_members/cle4_4.png) -### 6. Add Members to the Household +### 6. Add members to the household In the **Members** section, click **Add a line** to add family members. -![Screenshot: Click Add a line in Members section](/_images/en-us/get_started/first_household/03_add_members/5.png) +![Screenshot: Click Add a line in Members section](/_images/en-us/get_started/first_household/03_add_members/cle4_5.png) -### 7. Select Family Members +### 7. Select family members Select each individual from the dropdown. You can also click **Search More** to find specific individuals. -![Screenshot: Select individual from dropdown](/_images/en-us/get_started/first_household/03_add_members/6.png) +![Screenshot: Select individual from dropdown](/_images/en-us/get_started/first_household/03_add_members/cle4_6.png) -### 8. Assign Roles +### 8. Assign head of household -For each member, select their role in the household: +Assign Maria Garcia as head of household. -| Member | Role | -|--------|------| -| Maria Garcia | Head | -| Carlos Garcia | Spouse | -| Sofia Garcia | Child | +![Screenshot: Assign head of household](/_images/en-us/get_started/first_household/03_add_members/cle4_7.png) -![Screenshot: Assign roles to members](/_images/en-us/get_started/first_household/03_add_members/7.png) - -### 9. Save the Household +### 9. Save the household Click **Save** to update the household with its members. -![Screenshot: Save button](/_images/en-us/get_started/first_household/03_add_members/8.png) +![Screenshot: Save button](/_images/en-us/get_started/first_household/03_add_members/cle4_8.png) -### 10. Verify the Completed Household +### 10. Verify the completed household Review the household record. You should see all three family members listed with their roles. -![Screenshot: Completed household with all members](/_images/en-us/get_started/first_household/03_add_members/9.png) +![Screenshot: Completed household with all members](/_images/en-us/get_started/first_household/03_add_members/cle4_9.png) -## What You Accomplished +## What you accomplished You've learned how to: @@ -123,7 +117,7 @@ You've learned how to: - Assign roles to household members - Verify the completed household -## Key Concepts +## Key concepts | Concept | Description | |---------|-------------| @@ -131,7 +125,7 @@ You've learned how to: | **Member** | An individual linked to a group | | **Role** | The person's relationship to the household (Head, Spouse, Child, etc.) | -## Are You Stuck? +## Are you stuck? **Can't find the individual in the dropdown?** Make sure you've saved the individual record first. Search for them using the **Search More** option. diff --git a/docs/get_started/first_household/index.md b/docs/get_started/first_household/index.md index 9c3defd1..61083042 100644 --- a/docs/get_started/first_household/index.md +++ b/docs/get_started/first_household/index.md @@ -4,7 +4,7 @@ openspp: products: [registry, programs] --- -# Your First Household +# Your first household Hands-on tutorial for registering your first household in OpenSPP. @@ -12,7 +12,7 @@ Hands-on tutorial for registering your first household in OpenSPP. This tutorial walks you through creating a household in the OpenSPP registry, from accessing the registry to adding family members. -## What You'll Learn +## What you'll learn By the end of this tutorial, you will have: @@ -21,23 +21,24 @@ By the end of this tutorial, you will have: - Registered individual family members - Linked individuals to the household with their roles -## Tutorial Steps +## Tutorial steps This tutorial covers the following steps: -1. **Access the Registry** - Navigate to the Registry module and understand the interface -2. **Create a Household** - Register a new household group -3. **Add Members** - Create individuals and link them to the household +1. **Access the registry** - Navigate to the Registry module and understand the interface +2. **Create a household** - Register a new household group +3. **Add members** - Create individuals and link them to the household ## Prerequisites Before starting this tutorial: - OpenSPP should be installed and running (see {doc}`../installation/index`) +- OpenSPP SPMIS should be installed - Sample data loaded for exploration (see {doc}`../explore/index`) - Access to OpenSPP with Registry Officer or Administrator privileges -## Get Started +## Get started Click **Step 1** below to begin, or use the navigation to jump to any step. diff --git a/docs/get_started/first_program/01_setup_registry.md b/docs/get_started/first_program/01_setup_registry.md index 5a8f8064..e66a6a19 100644 --- a/docs/get_started/first_program/01_setup_registry.md +++ b/docs/get_started/first_program/01_setup_registry.md @@ -4,35 +4,35 @@ openspp: products: [registry, programs] --- -# Step 1: Access the Beneficiary Registry +# Step 1: Access the beneficiary registry This tutorial is for **users** who are new to OpenSPP and want to learn how to access the beneficiary registry. -## What You'll Do +## What you'll do Learn how to navigate to the Registry module and understand the Registry Search Portal - the central interface for managing beneficiaries in OpenSPP. -## Before You Start +## Before you start - You need access to OpenSPP with appropriate permissions - OpenSPP should be installed and running - Allow 2-3 minutes to complete this step -## The Scenario +## The scenario You're setting up a **Cash Transfer for Vulnerable Families** program. This program will provide monthly cash assistance to low-income families with children under 5 years old. First, you need to understand how to access and use the beneficiary registry. ## Steps -### 1. Navigate to Registry +### 1. Navigate to registry After logging in to OpenSPP, you'll see the sidebar menu on the left. Click **Registry** to access the beneficiary management portal. ![Screenshot: Sidebar showing Registry option](/_images/en-us/get_started/first_program/01_setup_registry/01-sidebar-registry.png) -### 2. Explore the Registry Search Portal +### 2. Explore the registry search portal -The Registry Search Portal is the main interface for managing beneficiaries. It provides a privacy-first approach where you search for records rather than browsing lists. +The registry search portal is the main interface for managing beneficiaries. It provides a privacy-first approach where you search for records rather than browsing lists. ![Screenshot: Registry Search Portal overview](/_images/en-us/get_started/first_program/01_setup_registry/02-registry-search-portal.png) @@ -47,19 +47,19 @@ Key elements of the interface: | **All Registrants** dropdown | Filter by registrant type | | **Recently Viewed** | Quick access to records you've viewed recently | -### 3. Register New Individuals +### 3. Register new individuals Click the **New Individual** button to register individual people (e.g., a single person applying for assistance). ![Screenshot: New Individual button highlighted](/_images/en-us/get_started/first_program/01_setup_registry/03-new-individual-button.png) -### 4. Register New Groups +### 4. Register new groups Click the **New Group** button to register households or families (e.g., a family unit applying together). ![Screenshot: New Group button highlighted](/_images/en-us/get_started/first_program/01_setup_registry/04-new-group-button.png) -### 5. Use the Search Function +### 5. Use the search function The search bar allows you to find existing beneficiaries. Click on the search bar to begin typing. @@ -71,7 +71,7 @@ Enter at least 3 characters to search by: - Phone number - Email address -### 6. View Search Results +### 6. View search results In this example, searching for "Garcia" returns matching beneficiaries. The results show the beneficiary name, type (Individual or Group), and when the record was last updated. @@ -79,16 +79,16 @@ In this example, searching for "Garcia" returns matching beneficiaries. The resu This privacy-first search approach ensures beneficiary data is protected - you must actively search for records rather than browsing through lists. -## What You Accomplished +## What you accomplished You've learned how to: - Access the Registry module from the sidebar -- Navigate to the Registry Search Portal +- Navigate to the registry search portal - Understand the key interface elements for managing beneficiaries - Use the search function to find existing records -## Key Concepts +## Key concepts | Concept | Description | |---------|-------------| @@ -97,7 +97,7 @@ You've learned how to: | **Privacy-First Search** | Must search to find records; no open browsing | | **Recently Viewed** | Quick access to records you've accessed | -## Are You Stuck? +## Are you stuck? **Can't find Registry in the sidebar?** Make sure you're logged in with appropriate permissions. Ask your system administrator to grant you access to the Registry module. diff --git a/docs/get_started/first_program/03_create_program.md b/docs/get_started/first_program/03_create_program.md index 2ae88ce2..80773157 100644 --- a/docs/get_started/first_program/03_create_program.md +++ b/docs/get_started/first_program/03_create_program.md @@ -4,87 +4,82 @@ openspp: products: [registry, programs] --- -# Step 3: Create Your First Social Protection Program +# Step 3: Create your first social protection program This tutorial is for **users** who want to learn how to set up a social protection program in OpenSPP. -## What You'll Do +## What you'll do -Create a "Cash Transfer for Vulnerable Families" program that will provide monthly cash assistance to eligible families. You'll configure the basic program settings including the program name, target beneficiaries, and currency. +Create a "Cash transfer for vulnerable families" program that will provide monthly cash assistance to eligible families. You'll configure the basic program settings including the program name, target beneficiaries, and currency. -## Before You Start +## Before you start -- You completed [Step 2: Import Beneficiaries](02_import_beneficiaries.md) +- You completed [Step 2: Import beneficiaries](02_import_beneficiaries.md) - Your registry has family and individual data - You need **System Administrator** or **Program Manager** access - Allow 5-10 minutes to complete this step -## The Scenario +## The scenario -You're creating a **Cash Transfer for Vulnerable Families** program with these goals: +You're creating a **Cash transfer for vulnerable families** program with these goals: - **Target**: Low-income families with young children - **Benefit**: Monthly cash transfer - **Currency**: Philippine Peso (PHP) - **Distribution**: Monthly recurring payments +Your program targets vulnerable families. To identify them, you'll use two criteria: +1. **Income Test**: Family earns less than 10,000 PHP per month +2. **Child Test**: Family has at least one child under 5 years old + ## Steps -### 1. Access the Programs Module +### 1. Access the programs module Click the **four-square icon** in the top-left corner to open the main menu. Then click **Programs**. ![Screenshot: Main menu with four-square icon and Programs option highlighted](/_images/en-us/get_started/first_program/03_create_program/01-programs-list.png) -### 2. Create a New Program +### 2. Create a new program Click the **Create** button in the top-left corner of the Programs list. ![Screenshot: Programs list view with Create button highlighted in top-left](/_images/en-us/get_started/first_program/03_create_program/02-create-program-button.png) -### 3. Enter Basic Program Information +### 3. Enter basic program information You'll see the program creation form. Fill in the following basic information: -**Program Name**: Cash Transfer for Vulnerable Families +**Program Name**: Cash transfer for vulnerable families **Target Type**: Select **Group** from the dropdown. This means the program will evaluate families (groups) for eligibility, not individual people. ![Screenshot: Program creation form showing Program Name field filled with "Cash Transfer for Vulnerable Families" and Target Type set to "Group"](/_images/en-us/get_started/first_program/03_create_program/03-program-name.png) -### 4. Set the Currency +### 4. Set the currency Scroll down to the **Currency** field and select **PHP - Philippine Peso** from the dropdown. ![Screenshot: Currency field showing PHP - Philippine Peso selected](/_images/en-us/get_started/first_program/03_create_program/04-currency.png) -### 5. Review the Configuration Tabs - -Notice there are several tabs at the top of the form: -- **Configuration**: Basic program settings (where you are now) -- **Eligibility**: Where you'll set rules for who qualifies -- **Cycle Manager**: Controls how often benefits are distributed -- **Entitlement Manager**: Defines what benefits are given - -For now, we'll just create the basic program. You'll configure these in the next steps. - -![Screenshot: Program form showing the four tabs: Configuration, Eligibility, Cycle Manager, Entitlement Manager](/_images/en-us/get_started/first_program/03_create_program/05-program-quick-options.png) - -### 6. Leave Other Settings as Default +### 5. Configure the program -Keep the default settings for now: -- **Auto-import Eligible Beneficiaries**: Unchecked (you'll manually control enrollment) -- **Notification Settings**: Empty (no notifications yet) -- **Journal**: Empty (accounting setup comes later) +Click "Next: Configure Program" to proceed with the configurations. Notice that there are several tabs at the top of the form: +- **Who Qualifies?** (where you are now): Define the criteria that determine who can participate in this program +- **What Do They Receive?**: Configure what beneficiaries will receive from this program +- **Distribution Schedule**: Set up how often benefits will be distributed +- **Ongoing Compliance (Optional)**: Define criteria that beneficiaries must continue to meet to remain eligible. This setting is optional and can be left unselected if it should not be used. -These can be configured later as you become more familiar with OpenSPP. +![Screenshot: Program form showing the four tabs: Who Qualifies?, hat Do They Receive?, Distribution Schedule, Ongoing Compliance (Optional)](/_images/en-us/get_started/first_program/03_create_program/cle5_1.png) -![Screenshot: Lower portion of Configuration tab showing default settings](/_images/en-us/get_started/first_program/03_create_program/06-program-next-button.png) +### 6. Configure eligibility -### 7. Save the Program +Your program targets vulnerable families. To identify them, you'll use two criteria: +- **Income Test**: Family earns less than 10,000 PHP per month +- **Child Test**: Family has at least one child under 5 years old -Click the **Save** button in the top-left corner to create your program. +Click the **Create Program** button at the bottom to create your program. -![Screenshot: Save button in top-left corner of program form](/_images/en-us/get_started/first_program/03_create_program/07-program-step2-config.png) +![Screenshot: Create program button at the bottom of of program form](/_images/en-us/get_started/first_program/03_create_program/cle5_2.png) You should see a success notification: "Program created successfully." diff --git a/docs/get_started/first_program/index.md b/docs/get_started/first_program/index.md index e260215f..1105de96 100644 --- a/docs/get_started/first_program/index.md +++ b/docs/get_started/first_program/index.md @@ -4,7 +4,7 @@ openspp: products: [registry, programs] --- -# Your First Program +# Your first program End-to-end tutorial for creating your first social protection program. @@ -12,7 +12,7 @@ End-to-end tutorial for creating your first social protection program. This hands-on tutorial walks you through creating a complete social protection program in OpenSPP, from setting up your registry to distributing entitlements to beneficiaries. -## What You'll Learn +## What you'll learn By the end of this tutorial, you will have: @@ -23,28 +23,29 @@ By the end of this tutorial, you will have: - Generated and reviewed entitlements - Understood the complete program workflow -## Tutorial Steps +## Tutorial steps This tutorial covers the following steps: -1. **Setup Registry** - Create and configure your beneficiary registry -2. **Import Beneficiaries** - Add individuals and households to the registry -3. **Create Program** - Define a new social protection program -4. **Configure Eligibility** - Set up rules to determine who qualifies -5. **Run a Cycle** - Execute a program cycle to assess eligibility -6. **Distribute Entitlements** - Generate and review benefit entitlements -7. **Next Steps** - Where to go from here +1. **Setup registry** - Create and configure your beneficiary registry +2. **Import beneficiaries** - Add individuals and households to the registry +3. **Create program** - Define a new social protection program +4. **Configure eligibility** - Set up rules to determine who qualifies +5. **Run a cycle** - Execute a program cycle to assess eligibility +6. **Distribute entitlements** - Generate and review benefit entitlements +7. **Next steps** - Where to go from here ## Prerequisites Before starting this tutorial: - OpenSPP should be installed and running (see {doc}`../installation/index`) +- OpenSPP SPMIS should be installed - Sample data loaded for exploration (see {doc}`../explore/index`) - Basic familiarity with {doc}`/learn/concepts/index` - Access to OpenSPP with administrator privileges -## Get Started +## Get started Click **Step 1** below to begin, or use the navigation to jump to any step. diff --git a/docs/index.md b/docs/index.md index a83021f1..d927e470 100644 --- a/docs/index.md +++ b/docs/index.md @@ -20,7 +20,7 @@ OpenSPP is an open-source, modular and highly interoperable platform. The platfo OpenSPP is a Digital Public Good. It is built on more than 60 open-source modules, and leverages and contributes to other open-source projects including OpenG2P, MOSIP, OpenCRVS, Odoo, Payment Hub EE, ID PASS, CommCare, Metabase and OpenFn -## Get Started +## Get started New to OpenSPP? Start here: @@ -28,7 +28,7 @@ New to OpenSPP? Start here: - **{doc}`get_started/index`** - Install and set up your first program - **{doc}`learn/whats_new_v2`** - What's new in OpenSPP V2 -## Documentation by Role +## Documentation by role | I am a... | I need to... | Start here | |-----------|--------------|------------| @@ -37,7 +37,7 @@ New to OpenSPP? Start here: | **Developer** | Extend OpenSPP, build integrations | {doc}`developer_guide/index` | | **Sys Admin** | Deploy, secure, maintain OpenSPP | {doc}`ops_guide/index` | -## Platform Overview +## Platform overview ### SP-MIS @@ -57,7 +57,7 @@ The Farmer Registry stores and manages farm holding and farm owner data, support The Disability Registry is an organized database for systematically recording and managing information about individuals with disabilities within a specific population or geographic area. It contains important information to facilitate services and assistance for people with disabilities, including access to social protection programs. -## Guiding Principles +## Guiding principles Our guiding principles are informed by the Digital Public Goods Standard and the Principles for Digital Development. @@ -67,7 +67,7 @@ Our guiding principles are informed by the Digital Public Goods Standard and the - **Interoperability**: The platform is designed to support system interoperability - critical for the creation of cohesive and efficient digital ecosystems. - **Inclusivity**: Our products can be customized to suit linguistic and cultural requirements, accessibility, digital literacy, and deployment in remote and less-developed contexts. -## Get Help +## Get help OpenSPP is currently in active development. If you have questions or need support: