Water App User Guide

Site: water.agipro.dev | App versions: frappe 15.100.1, water 0.0.1 | Updated: 2026-02-24

This guide explains how to use the Water app for intake, field execution, billing, complaints, governance, and reporting.

1. Roles

• Water Data Entry: create records and submit items for review.
• Water Supervisor: operational review, assignment, and progress control.
• M&E Officer: quality and compliance review plus analytics.
• Program Manager: approvals, closure decisions, governance oversight.
• System Manager: setup, permissions, workflow, and platform control.

Record visibility can be scoped by user defaults: Country, Region, District.

2. Workspace Navigation

1. Login to Desk and open UNICEF Water Operations.
2. Use top sections for Intake, Field Execution, and Rapid Create.
3. Use watchlists for pending work and card groups for deep navigation.

3. Daily Operations Flow

3.1 Intake

1. Create or verify Water Customer.
2. Create Service Request with required data: customer, water_establishment, service_type, request_date, source_channel.
3. Use workflow actions to move request to review and execution.

3.2 Field Work

1. Create Maintenance Request with water_point, reported_on, severity.
2. Track via status: Open, In Progress, Resolved, Closed.
3. Create Field Inspection and attach evidence for site validation.

3.3 Water Quality

1. Create Water Quality Test for the related water_point.
2. Enter lab values. System sets result_status to Passed or Failed.
3. For failed tests, upload attachment (mandatory).

3.4 Complaints and Calls

1. Log customer issues in Complaint.
2. Capture call flow in Call Center Log.
3. Use watchlists to clear open complaints and pending validations.

4. Workflow Patterns

4.1 Transactional pattern

States:

Draft -> Submitted -> Supervisor Review -> M&E Review -> Approved -> In Progress -> Completed -> Closed (with Rejected and Reopen path).

Main actions: Submit, Assign Review, Send to M&E, Approve, Request Changes, Reject, Start, Complete, Close, Reopen.

4.2 Master/setup pattern

States:

Draft -> Under Review -> Approved with control states Rejected and Inactive.

Main actions: Submit, Approve, Request Changes, Reject, Revise, Deactivate, Reactivate.

4.3 Status-driven records

These are mainly managed by status field and validations rather than workflow action buttons:

• Maintenance Request
• Field Inspection
• Water Quality Test
• Beneficiary Feedback

5. Key Validation Rules

• Maintenance Request: target date cannot be before report date; High must be within 48h, Critical within 24h; closure requires completion attachment.
• Water Quality Test: failed test requires attachment; updates linked water point quality status.
• Field Inspection: availability and downtime hours cannot be negative.

6. Reports

• Water Point Functionality by District
• Overdue Maintenance Requests
• Water Quality Compliance Trend
• Population Served by Project and Quarter
• Feedback Resolution Time

7. API Endpoints

• GET /api/method/water.api.get_water_points_geojson
• GET /api/method/water.api.export_unicef_water_data
• POST /api/method/water.api.sync_field_inspections
• POST/GET /api/method/water.api.register_public_file_in_manager

8. Troubleshooting

1. Check role assignment and geo defaults.
2. Check required attachments before close/resolve actions.
3. Clear cache if workspace or labels are stale.
4. If permission-hook errors continue, clear app_hooks cache and restart web workers.

Guide URL: /files/UNICEF_Water_Workspace_User_Guide.html