How centre-for-open-societal-systems/oan_grievance_service works
OAN Grievance Service is a Frappe backend for grievance intake and redressal. Users and staff reach versioned REST endpoints to save drafts or submit cases; the backend validates and persists grievances, applies access controls, routes cases to officers, tracks workflow and SLA deadlines, and sends notifications. Supporting capabilities include attachments and scanning, change requests, audit/timeline history, dashboards, and configurable master data. The graph uses the README and source-index references for relationships; unsampled implementation details are not assumed.
Main entry points: grievance.py Grievance API · routing.py Assignment routing · sla.py SLA and escalation · tasks.py Scheduled jobs
Components 23
API and intake
- API router
oan_grievance_service/api/router.py - Grievance API
oan_grievance_service/api/v1/grievance.py - Draft API
oan_grievance_service/api/v1/draft.py - Attachment API
oan_grievance_service/api/v1/attachment.py
Casework services
- Grievance record
oan_grievance_service/grievance_management/doctype/grievance/grievance.py - Assignment routing
oan_grievance_service/services/routing.py - Case lifecycle
oan_grievance_service/services/lifecycle.py - SLA and escalation
oan_grievance_service/services/sla.py - Ticket numbering
oan_grievance_service/services/ticket_number.py - Case timeline
oan_grievance_service/grievance_management/doctype/grievance_timeline/grievance_timeline.py - Change requests
oan_grievance_service/grievance_requests/doctype/grievance_change_request/grievance_change_request.py
Access and configuration
- Permission rules
oan_grievance_service/permissions.py - Officer assignments
oan_grievance_service/grievance_access_control/doctype/grievance_rbac_assignment/grievance_rbac_assignment.py - Administrative areas
oan_grievance_service/grievance_masters/doctype/grievance_administrative_area/grievance_administrative_area.py - Service configuration
oan_grievance_service/grievance_masters/doctype/grievance_service_category/grievance_service_category.py
Operations and reporting
- Notifications
oan_grievance_service/services/notifications.py - Attachment scanning
oan_grievance_service/services/scanning.py - Scheduled jobs
oan_grievance_service/tasks.py - Dashboards and statistics
oan_grievance_service/services/dashboard.py
Other components
- Submitters and staff
- Frappe database
- ClamAV service
- SMS gateway
Connections 34
- Submitters and staff → API router: submit requests
README.md - API router → Grievance API: routes to
oan_grievance_service/api/router.py - API router → Draft API: routes to
oan_grievance_service/api/router.py - API router → Attachment API: routes to
oan_grievance_service/api/router.py - Grievance API → Grievance record: creates and reads
oan_grievance_service/api/v1/grievance.py - Grievance API → Assignment routing: invokes
oan_grievance_service/api/v1/grievance.py - Grievance API → Case lifecycle: invokes
oan_grievance_service/api/v1/grievance.py - Grievance API → SLA and escalation: invokes
oan_grievance_service/api/v1/grievance.py - Grievance API → Ticket numbering: generates ticket
oan_grievance_service/api/v1/grievance.py - Grievance API → Case timeline: reads timeline
oan_grievance_service/api/v1/grievance.py - Grievance API → Permission rules: checks access
oan_grievance_service/api/v1/grievance.py - Draft API → Grievance record: saves draft
oan_grievance_service/api/v1/draft.py - Draft API → Ticket numbering: generates ticket
oan_grievance_service/api/v1/draft.py - Attachment API → Attachment scanning: uses scanner
README.md - Assignment routing → Officer assignments: queries assignments
oan_grievance_service/services/routing.py - Assignment routing → Administrative areas: matches area scope
oan_grievance_service/services/routing.py - Assignment routing → SLA and escalation: invokes
oan_grievance_service/services/routing.py - Assignment routing → Case lifecycle: invokes
oan_grievance_service/services/routing.py - Assignment routing → Notifications: queues notices
oan_grievance_service/services/routing.py - SLA and escalation → Notifications: sends reminders
oan_grievance_service/services/sla.py - SLA and escalation → Case timeline: records events
oan_grievance_service/services/sla.py - SLA and escalation → Officer assignments: finds escalation officers
oan_grievance_service/services/sla.py - Change requests → Permission rules: checks permissions
oan_grievance_service/grievance_requests/doctype/grievance_change_request/grievance_change_request.py - Change requests → Officer assignments: checks assignments
oan_grievance_service/grievance_requests/doctype/grievance_change_request/grievance_change_request.py - Scheduled jobs → SLA and escalation: runs jobs
oan_grievance_service/tasks.py - Scheduled jobs → Notifications: dispatches notices
oan_grievance_service/tasks.py - Scheduled jobs → Attachment scanning: runs scans
oan_grievance_service/tasks.py - Scheduled jobs → Assignment routing: invokes routing
oan_grievance_service/tasks.py - Notifications → SMS gateway: sends SMS
README.md - Attachment scanning → ClamAV service: scans uploads
README.md - Grievance record → Frappe database: persists records
README.md - Officer assignments → Frappe database: stores assignments
README.md - Service configuration → Frappe database: stores configuration
README.md - Submitters and staff → Dashboards and statistics: views summaries
README.md