OpenSPP Documentation v2.0

⌘ K
  • Products
    • OpenSPP SP-MIS
      • Modules included
      • Relevant user guides
      • Relevant configuration guides
      • Demo module
    • OpenSPP Social Registry
      • Modules included
      • Relevant user guides
      • Relevant configuration guides
    • OpenSPP Farmer Registry
      • Modules included
      • Relevant user guides
      • Relevant configuration guides
    • OpenSPP DRIMS
      • Modules included
      • Relevant user guides
      • Relevant configuration guides
    • OpenSPP Disability Registry
      • Modules included
      • Relevant user guides
      • Relevant configuration guides
    • Custom module combinations
    • Features in OpenSPP
      • Unified registry
      • GIS & land management
      • Program management
      • Eligibility & targeting
      • Payment & disbursement
      • In-Kind benefits
      • Data integration & APIs
      • Change management
      • Grievance redress
  • Learn
    • Registry
    • Programs
    • Cycles
    • Eligibility
    • Compliance
    • Entitlements
    • Payments
    • Deduplication
    • Change requests
  • Get started
    • Installing OpenSPP
      • Docker installation
    • Module installation
      • General module installation
      • SP-MIS installation
      • Social Registry installation
      • Farmer Registry installation
      • DRIMS installation
      • Disability Registry installation
    • Try our products
      • Try OpenSPP SP-MIS
        • Install SP-MIS demo data
        • SP-MIS Stories
        • SP-MIS Demo scenarios
    • Choosing your configuration
    • Configuration vs customization
    • From Proof of Concept to Pilot
  • User guide
    • Getting started
      • Navigating the OpenSPP interface
      • Administrating role-based access
    • Registry
      • Register an individual
      • Register a group
      • Search and filter registrants
      • Import registrant data
      • Export registrant data
      • Manage farm data
    • Change Requests
      • Submit a change request
      • Review a change request
      • Change request types
    • Case management
      • Core case management workflow
    • Programs
      • Create programs
      • Manage in-kind products
      • Work with program cycles
      • Enroll beneficiaries
      • Allocate funds to programs
      • Manage entitlements
    • Payments
      • View Service Points
    • Approvals
      • Review and Approve Requests
    • DRIMS User Guide
      • Understand the Dashboard
      • Receive a Donation
      • Manage Inventory
      • Submit a Relief Request
      • Process a Dispatch
      • Handle Returns
    • Grievance Redress Mechanism (GRM)
      • Manage grievances
    • Geographic Information System (GIS)
      • View maps and generate reports
    • Reference
      • Geographic Areas
      • Vocabularies (Code Lists)
  • Configuration guide
    • Alerts
      • Alerts overview
    • Approval workflows
      • Approval workflows overview
      • Approval tiers
      • Batch approvals and freeze periods
    • Area management
      • Area management overview
      • HDX COD integration
    • Audit configuration
      • Audit configuration overview
      • Audit backends
    • Banking
      • Banking overview
    • Case management
      • Case management overview
      • Case stages
      • Case teams
    • CEL expressions
      • CEL quick start
      • CEL syntax reference
      • Variables
      • CEL cookbook
      • CEL troubleshooting
    • Change request types
      • Overview
      • Creating change request types
      • Field mappings
      • Conflict and duplicate detection
      • Common configuration patterns
      • Custom detail models
      • Troubleshooting
    • Consent configuration
      • Consent management overview
      • Configuring privacy notices
      • Recording consent
      • API consent filtering
    • Custom fields
      • Custom fields overview
    • DRIMS Configuration Guide
      • Configuring Warehouses
      • Configuring Approval Workflows
      • Configuring Alerts and Thresholds
      • Configuring Vocabularies
    • Eligibility rules
      • CEL expressions for eligibility
      • Geographic targeting
      • Expression templates
      • Testing eligibility rules
      • Advanced eligibility configuration
    • Entitlement formulas
      • Cash calculations
      • In-kind entitlements
      • Formula library
      • Dynamic entitlements
      • Conditional logic
    • Event Data
      • Event Data Overview
      • Configuring Event Types
      • Defining Event Fields
    • Farmer registry
      • Farmer registry overview
      • Farm details, seasons, and activities
    • GIS configuration
      • GIS configuration overview
      • GIS reports and indicator layers
    • Grievance redress
      • Grievance redress overview
      • SLA rules
      • GRM teams and tags
    • Hazard management
      • Hazard management overview
      • Linking programs to hazard incidents
    • Import matching
      • Import matching overview
    • OpenSPP Studio
      • Studio Overview
      • Custom Fields (Registry Field Builder)
      • Event Type Designer
    • Role configuration
      • Access control overview
      • Assigning roles to users
      • Predefined roles
      • Creating custom roles
      • Troubleshooting
    • Scoring & Assessment
      • Scoring Framework Overview
      • Proxy Means Test (PMT) Configuration
      • Vulnerability Scoring Configuration
      • Social Welfare Development Index (SWDI)
      • Creating Custom Scoring Formulas
    • Service points
      • Service points overview
      • Service point lifecycle
    • Session tracking
      • Session tracking overview
    • Simulation
      • Simulation overview
    • Storage backend
      • Storage backend overview
    • Variables
      • Variables Overview
      • Creating Variables
      • Variable Types
      • Using Variables in CEL
    • Vocabulary System
      • Vocabulary Overview
      • Standard Vocabularies
      • Vocabulary Profiles
      • Custom Vocabularies
  • Developer guide
    • Development setup
    • Architecture
      • Module organization
      • Data model
    • Custom modules
      • Module scaffold
      • Models
      • Security
      • Views and menus
      • Mixins
      • Testing
      • Example: custom registry fields
    • Custom program managers
      • Manager pattern
      • Building a custom manager
      • Tutorial: build CCT program managers
    • Custom change request types
      • Detail models
      • Apply strategies
      • Approval hooks
      • Tutorial: build a transfer member CR type
    • API V2
      • API V2 Overview
      • Authentication
      • External Identifiers
      • Consent Management
      • API Resources
      • Search and Filtering
      • Batch Operations
      • Error Handling
      • Tutorial: build a Python API client
      • Studio API Integration
      • Entitlements and Cycles
      • Products and Service Points
    • DCI Integration
      • DCI Overview
      • OpenSPP as DCI Server
      • OpenSPP as DCI Client
      • DCI Protocol Details
    • Security and Encryption
    • CEL (Common Expression Language)
      • CEL Internals
    • Studio
    • Audit and Versioning
    • Contributing
  • Operations guide
    • Deployment
      • Production Hardening
    • Security
      • Access Control
      • Data Classification
      • PII Encryption
      • Key Management
      • Audit Logging
      • Security Scanning
    • Storage
    • Backup & Recovery
    • Monitoring & Alerts
  • Reference
    • Modules Reference
      • Alerts
      • Analytics
      • API V2
        • Change Request
        • Cycles
        • Data
        • Entitlements
        • GIS API
        • Products
        • Service Points
        • Simulation API
        • Vocabulary
      • Approval Workflows
      • Area Management
      • HDX COD Integration
      • Attachment Antivirus Scan
      • Audit
      • Banking / Bank Details
      • Base (Common)
      • Base Settings
      • Branding Kit
      • Case Management Base
        • CEL Rules
        • Demo Data
        • Entitlements Integration
        • Graduation Integration
        • Programs Integration
        • Registry Integration
        • Session Integration
      • CEL Domain Query Builder
        • Event Data Integration
        • Registry Search
        • Vocabulary Integration
        • Expression Widget
      • Registry Search
      • Expression Widget
      • Change Request V2
        • Advanced Types
        • Base Types
      • QR Credentials (Claim 169)
      • Consent
      • Custom Fields
      • DCI Core
        • Client
        • Client - CRVS
        • Client - Disability
        • Client - IBR
        • Demo
        • Server
      • Demo
      • Disability Registry
      • Document Management System
      • DRIMS - Disaster Response Inventory Management
        • Sri Lanka Configuration
        • Sri Lanka Demo
      • Encryption: Base
      • Event Data
      • Farmer Registry
        • Change Request Types
        • Dashboard
        • Demo
        • Vocabularies
      • GIS
        • Indicators
        • Reports
        • Reports - Programs
        • Registrant GIS
      • Graduation Management
      • Grievance Redress Mechanism
        • Case Link
        • CEL Rules
        • Demo Data
        • Programs Integration
        • Registry Integration
      • Hazard & Emergency Management
        • Programs Integration
      • Programs Integration
      • Hide Menus Base
      • HXL Integration
        • Area Integration
      • Import Match
      • Indicator
      • Indicator Studio
      • Irrigation
      • Key Management
      • Land Record
      • Metric
      • Metric Service
      • MIS Demo V2
      • API: Oauth
      • Programs
      • Registrant GIS
      • Registry
      • Registry Group Hierarchy
      • Registry Search Portal
      • Scoring
        • Programs Bridge
      • Security
      • Service Points
      • Session Tracking
      • Targeting Simulation
      • Source Tracking
      • Starter: Farmer Registry
      • Starter: Social Registry
      • Starter: SP-MIS
      • Storage Backend
      • Studio
        • API v2 Integration
        • Change Requests
        • Events
      • User Roles
      • Versioning
      • Vocabulary
      • Theme
    • Vocabulary Reference
    • Humanitarian Terms Glossary
    • OpenSPP Glossary
    • What's new in OpenSPP v2
  • Community and support
    • Contributing
    • Internationalization and Localization
    • Modules Maturity Levels and Development Status Policy
    • Module Lifecycle - Maintainer Role Policy
    • Contributor Covenant Code of Conduct
    • OpenSPP Vulnerability Disclosure Policy
    • Why OpenSPP is built on Odoo
    • Licensing

openspp.org openspp.org

Navigating the OpenSPP interface – User guide
  • repository
  • open issue
  • suggest edit
  • .md
Contents
  • What you will do
  • Logging in
    • Step 1: Open OpenSPP in your browser
    • Step 2: Enter your credentials
    • Step 3: First-time login
  • The main interface
    • The app menu
    • The main menu (sidebar)
    • The user menu
    • Understanding breadcrumbs
  • Finding your way around
    • Using search
    • Filtering lists
  • Common actions
    • Creating a new record
    • Editing an existing record
    • Saving changes
    • Discarding changes
    • Deleting records
  • Getting help
    • In-app guidance
    • Contacting your administrator
  • Are you stuck?
  • Next steps

Navigating the OpenSPP interface

Contents

  • What you will do
  • Logging in
    • Step 1: Open OpenSPP in your browser
    • Step 2: Enter your credentials
    • Step 3: First-time login
  • The main interface
    • The app menu
    • The main menu (sidebar)
    • The user menu
    • Understanding breadcrumbs
  • Finding your way around
    • Using search
    • Filtering lists
  • Common actions
    • Creating a new record
    • Editing an existing record
    • Saving changes
    • Discarding changes
    • Deleting records
  • Getting help
    • In-app guidance
    • Contacting your administrator
  • Are you stuck?
  • Next steps

Navigating the OpenSPP interface#

Applies to: Social Registry, SP-MIS, DRIMS

What you will do#

Learn how to log in to OpenSPP, navigate the interface, and perform common actions like creating, editing, and saving records.

Logging in#

Step 1: Open OpenSPP in your browser#

Open your web browser and go to your organization's OpenSPP address. This is typically something like https://openspp.yourorganization.gov.

Note

Your administrator will provide you with the exact web address to use.

OpenSPP login page

Step 2: Enter your credentials#

  1. Type your username in the Email field.

  2. Type your password in the Password field.

  3. Click the Log in button.

Step 3: First-time login#

If this is your first time logging in, you may be asked to change your password:

  1. Enter your current (temporary) password.

  2. Enter your new password.

  3. Confirm your new password by typing it again.

  4. Click Change password.

Tip

Choose a password that is easy for you to remember but hard for others to guess. Use a mix of letters, numbers, and symbols.

Note

You can also change your password at any time by going to your User Menu (top right), selecting My Preferences and then opening the Security tab.

The main interface#

After logging in, you will see the main OpenSPP interface. Here are the key areas:

Main interface overview

Area

Name

What it does

1

App menu

Switch between different parts of OpenSPP

2

Main menu

Access features within the current section

3

Search bar

Search for records

4

User menu

Access your profile and settings

5

Main content area

Where you view and work with data

6

Breadcrumbs

Shows where you are and lets you go back

The app menu#

The app menu appears at the top left of the screen. Click it to see all the sections available to you.

App menu expanded

Common sections include:

Section

What you will find

Registry

Individuals, groups, and households

Programs

Social protection programs and enrollment

Payments

Payment processing and service points

Settings

System configuration (if you have access)

Note

You may see different sections depending on your role and permissions.

The main menu (sidebar)#

Once you select a section from the App Menu, the Main Menu on the left shows features within that section.

Sidebar navigation

For example, in the Registry section you might see:

  • Search

  • Registry (CEL)

  • Browse All (Audit)

  • Configuration

Click any item to open it in the main content area.

The user menu#

Click your name or profile icon in the top right corner to open the User Menu.

User menu options

Option

What it does

My Preferences

View and update your account information, change your password, and customize your OpenSPP view

OpenSPP Documentation

Access the OpenSPP documentation

OpenSPP Support

Visit the OpenSPP official website for support

Log out

Sign out of OpenSPP

Understanding breadcrumbs#

Breadcrumbs appear below the top menu bar. They show where you are in the system and let you go back to previous pages.

Breadcrumb navigation

For example: .. / Food Assistance / Beneficiaries

  • Click .. to go back to the first page

  • Click Food Assistance to go back to the program's page

  • Click Beneficiaries to go back to beneficiary list page

  • Martinez, Miguel is where you are now

Finding your way around#

Using search#

The search bar at the top lets you quickly find records.

Using the search bar

  1. Click in the search bar.

  2. Type what you are looking for (a name, ID number, Phone or email).

  3. Press Enter or click the search icon.

Filtering lists#

When viewing a list of records, you can filter to find what you need.

Filter options on a list

  1. Click the Advanced dropdown above the list.

  2. Select a filter option.

  3. The list updates to show only matching records.

To remove filters, click the X Clear Filters button.

Common actions#

Creating a new record#

  1. Navigate to the section where you want to create a record (for example, Registry > Individuals).

  2. Click the New button in the top left corner.

New button location

  1. A blank form opens. Fill in the required fields (marked with a bold label or asterisk).

  2. Click Save when finished.

Editing an existing record#

  1. Find and open the record you want to change.

  2. Click on a field and edit directly.

Note

Edit functionality may only be available for certain user roles. If you cannot edit a record, contact your administrator to check your permissions.

  1. Make your changes.

  2. Click Save to keep your changes.

Saving changes#

After creating or editing a record, click the Save button to store your changes.

Save button location

Note

If you navigate away without saving, your changes will automatically be saved.

Discarding changes#

If you made changes you do not want to keep:

  1. Click the Discard button before saving.

Discard button location

  1. The record returns to its previous state.

Deleting records#

Warning

Deleting records is permanent. Make sure you really want to remove the record before proceeding.

  1. Open the record you want to delete.

  2. Click the Action menu (Gear icon).

Action menu location

  1. Select Delete.

  2. Confirm when prompted.

Note

You may not be able to delete certain records if they are linked to other data in the system. If you see an error, contact your administrator.

Getting help#

In-app guidance#

Some screens include help text and tooltips:

  • Hover over a field label to see a description of what to enter

  • Look for information icons next to complex fields

Contacting your administrator#

If you need help with:

Issue

Who to contact

Login problems

System Administrator

Permission issues

System Administrator

How to do a specific task

Your supervisor or training lead

System errors

IT Support

Tip

When reporting a problem, note down any error messages you see and what you were trying to do. This helps your support team resolve the issue faster.

Are you stuck?#

Cannot find the menu you need? Your access depends on your role. If you need access to a feature you cannot see, ask your administrator to check your permissions.

The page shows "Access Denied"? You do not have permission to view this page. Contact your administrator if you believe you should have access.

Clicked the wrong button and lost your work? If you have not saved yet, try pressing Ctrl + Z to undo in text fields. For larger mistakes, you may need to re-enter the information.

The system is slow or unresponsive? Try these steps:

  1. Refresh the page (press F5)

  2. Clear your browser cache

  3. Try a different browser

  4. Contact IT support if the problem continues

Forgot your password? Click "Forgot Password" on the login page to reset it. If that option is not available, contact your administrator.

Next steps#

Now that you know how to navigate OpenSPP, you are ready to start working with the system.

  • Registry - Learn how to register individuals and groups

  • Programs - Learn about managing programs

  • Change Requests - Learn how to submit and process change requests

previous

Getting started

next

Administrating role-based access

By The OpenSPP community
© Copyright OpenSPP.

The text and illustrations in this website are licensed by the OpenSPP Project under a Creative Commons Attribution 4.0 International license. All other trademarks are owned by their respective owners.