Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
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.
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.
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.
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 34 additions & 31 deletions docs/get_started/explore/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand All @@ -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.
Expand Down
15 changes: 7 additions & 8 deletions docs/get_started/first_household/01_access_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:

Expand All @@ -56,15 +56,15 @@ 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:

- Access the Registry module from the sidebar
- 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.
Expand All @@ -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).
31 changes: 15 additions & 16 deletions docs/get_started/first_household/02_create_household.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:

Expand All @@ -41,37 +41,37 @@ 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:

- Create a new household (group) in the registry
- Enter basic household information
- Save and verify the household record

## Key Concepts
## Key concepts

| Concept | Description |
|---------|-------------|
| **Group** | A collection of individuals, typically a household or family |
| **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.
Expand All @@ -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).
Loading