Purpose of the module

The primary purpose of this module is to streamline attendance review and payment processing workflows for health campaign workers. It ensures that supervisors can:

• Access tools and functionalities tailored to their responsibilities.

• Maintain clear separation between proximity- and campaign-specific workflows.

• Facilitate accurate, timely payments for healthcare workers based on attendance.

Flows Overview

1. Proximity Supervisor Flow

This flow focuses on managing attendance records within a specific boundary assigned to the logged-in proximity supervisor.

Key Actions:

• View attendance: Filter, search, and view attendance data.

• Edit attendance: Modify attendance entries for accuracy.

• Approve attendance: Validate and approve attendance registers for payment processing.

2. Campaign Supervisor Flow

This flow supports campaign-wide bill generation.

Key Actions:

• View registers: Access to view registers to generate bills.

• Download reports: Export reports in Excel/PDF formats for stakeholder communication.

• Generate bills: Create bills based on three boundary levels: Country, Province, and District.

• If the boundary is set to a district, all the registers within that district will be consolidated into a single bill.

Interface Elements:

User Actions Flow:

1. Select a Project: Choose a project from the dropdown list.

2. Proceed to Next Screen: Click "Next" to access the registers associated with the project.

The Proximity Supervisor Flow for managing attendance registers is designed to provide supervisors with a seamless experience for selecting projects, viewing associated attendance records, and managing the details effectively. The flow emphasizes ease of navigation, quick access to project and register information, and actionable steps to edit or approve attendance records.

Core Features

• Project Selection: Enables supervisors to pick a specific project to manage.

• Registers Inbox: Displays filtered attendance registers for selected boundaries.

• View Attendance: Provides detailed attendance information for campaigns and projects.

• Edit Attendance: Allows supervisors to update attendee records.

• Approve Attendance: Facilitates approval with clear validation and comment requirements.

Each step in this flow ensures user-friendly interactions and adheres to the necessary validation rules and role-based permissions for supervisors and project managers.

Note: In Payments version 0.1, each user will be associated with only one project.

Sequence Diagram

Purpose:

This screen allows Campaign Supervisors to:

1. Filter attendance registers based on boundaries (Country, Province, and District) tied to the selected project and aggregation level.

2. View the list of registers within the selected boundary.

3. Generate bills for the selected boundary if all registers are approved.

Interface Elements:

Filters Section

no of levels will vary based on the aggregation level selection:

• Country: Dropdown menu to select the country (e.g., Mbazi Highlands).

  • Mandatory Field: Must be selected before applying filters.

• Province: Dropdown menu to select the province (e.g., Nampula).

  • Mandatory Field: Must be selected before applying filters.

• District: Dropdown menu to select the district (e.g., Murrupula).

  • Mandatory Field: Must be selected before applying filters.

• Apply Button: Triggers the filter to display attendance registers for the selected boundary.

Register Inbox

• Project Name: Displays the selected project name .

• Aggregation Level: Displays the selected aggregation level (e.g., District level).

• Register Status Summary:

  • Approved Registers: Shows the count of approved registers (e.g., 18).

  • Pending Registers: Shows the count of pending registers (e.g., 0).

Registers Table

Displays a tabular list of attendance registers for the filtered boundary, with the following columns:

Action Section

• Generate Bill Button:

  • Enabled State: If all registers are approved, this button becomes active, allowing users to trigger the bill generation process and bill is not already generated.

  • Disabled State: If any registers are pending approval, the button remains inactive.

User Actions Flow:

1. Filter Attendance Registers:

   • Mandatory Filters: The user must select a Country, Province, and District before clicking "Apply".

   • After clicking Apply, the attendance registers for the selected boundary are displayed.

2. View Attendance Registers:

   • The filtered registers are shown in a tabular format.

3. Generate Bill:

   • The Generate Bill button is enabled only if all the registers within the selected boundary are approved and bill is not generated already.

   • Clicking Generate Bill triggers the bill generation process:

     • A confirmation pop-up appears with the warning.

     • Buttons:

       • Cancel: Returns to the register list.

       • Proceed: Starts the bill generation process.

   • A toast message will be shown whether bill generation started or failed. and a info message will be displayed with same.

Scenarios and System Responses:

1. All If all registers within the selected boundary are approved Approved:

   • The Generate Bill button is enabled.

   • Upon clicking Generate Bill, an info message is displayed: "Bill generation in progress. Please wait."

2. Bill Already Generated:

   • If all registers within the selected boundary are approved but a bill has already been generated:

   • An info message is displayed: "Bill has already been generated for this boundary."

3. Pending Registers:

   • If some registers within the selected boundary are still pending approval:

   • An info message is displayed: "Bill cannot be generated until all the registers are approved."

Validations:

1. Boundary Selection:

   • All three boundary levels (Country, Province, and District) are mandatory for filtering attendance registers.

   • Error toast massage if you click on apply without selecting all mandatory boundaries.

2. The system verifies the approval status of all registers in the selected boundary before enabling the Generate Bill button.

API Endpoints:

The Campaign Supervisor Flow is designed to streamline the management of attendance registers and bill generation processes for supervisors overseeing specific projects and boundaries. This flow ensures efficient selection, filtering, and approval of registers and simplifies the generation and tracking of bills. It focuses on clear workflows, actionable feedback, and validation mechanisms to enhance usability and accuracy.

Core Features

• Project and Bill Aggregation Selection: Supervisors select a project and boundary aggregation level to narrow down the scope for attendance registers and billing.

• Registers Filtering and Bill Generation: Enables supervisors to filter registers based on boundaries, view attendance data, and generate bills only when all registers are approved.

• Bill Management (My Bills): Provides a centralised view of all generated bills, with tools for searching, filtering, and downloading them in preferred formats.

This structured approach empowers supervisors to manage attendance registers and related billing tasks with ease while adhering to necessary validations and role-based permissions.

Sequence Diagram:

This is the initial screen where the user selects:

1. Project: The specific project they are managing.

2. Bill Aggregation Level: The boundary level at which the bill should be generated (Country, Province, or District).

Users cannot proceed without filling out these fields.

Interface Elements:

User Actions Flow:

1. Use the dropdown menu to select the project.

2. Select one of the available aggregation levels (Country, Province, or District) from the dropdown.

3. Click the "Next" button to navigate to the register filtering screen.

Validations:

• Both fields are mandatory:

• If either the Project or Bill Aggregation Level is not selected, an error toast message is displayed if you try to proceed.

The "My Bills" section serves as a centralised dashboard for campaign supervisors to view and manage all bills associated with their assigned projects. By default, the dashboard displays all bills related to the projects under their supervision. Supervisors can search for specific bills or filter them using date ranges or by bill id.

Interface Elements:

Search Filters

1. Bill ID: Enter a specific Bill ID.

2. Date Range: Select a start and end date to filter bills within a specific time frame.

3. Action Buttons:

   • Search: Filters the results based on the provided criteria.

   • Clear Search: Resets the filters and shows all assigned bills.

Bill List

A table format displays the bills with the following columns:

Status Descriptions

• Generated: The bill has been successfully generated. The user can download it in PDF or Excel format.

• In Progress: The report is still being generated. The user should wait for completion.

• Failed: The report generation failed. The user can:

  • Retry the process.

  • Contact support if the issue persists.

API Endpoints:

Clicking on any register ID from the inbox displays detailed information about the attendance register. The screen includes information such as campaign details, attendance officer details, and attendee information. Users can perform two primary actions: Edit and Approve.

Interface Elements

• Campaign Details: Displays the campaign name, ID, and dates.

• Attendance Officer Details: Name, ID, and contact information.

• Attendee Information: Includes register ID, attendee names, and attendance data.

• Action Buttons:

  • Edit Attendance: Allows editing attendance details.

  • Approve Attendance: Approve the attendance register.

Interface Elements:

Validations and Conditions

1. Campaign Status:

   • If the campaign is ongoing, Edit and Approve buttons are disabled, and only a "Back" button is shown.

   • Administrators can override this behavior through MDMS (configurable settings).

2. Approved Registers:

   • If the register is already approved, the action buttons are disabled, and a "Back" button is displayed.

3. Role-Based Permissions:

   • Only authorized supervisors can access Edit/Approve features.

Action Flows

1. Edit Attendance Flow

a. Step 1: Pop-Up Confirmation

• Message: "Editing attendance will affect the number of days for attendees. Do you want to proceed?"

• Buttons:

  • Cancel: Close the pop-up.

  • Proceed: Navigate to the Edit Attendance screen.

b. Step 2: Edit Attendance Screen

• Validation:

  • Number of days worked must be a positive integer and must not exceed the event duration.

• Submit Button Behaviour:

  • Initially disabled until changes are made.

  • Upon submission:

    • Displays a success message: "Attendance updated successfully!"

    • Displays an error message if the update fails.

1. Approve Attendance Flow

   1. Step 1: Add Comment

      • Message: "Please add a comment before approving."

      • Input Field: Allows users to enter comments (mandatory).

      • Buttons:

        • Cancel: Closes the pop-up and returns to the view screen.

        • Submit: Proceeds to the final warning.

1. Step 2: Confirmation Pop-Up

   • Message: "Do you want to approve this attendance register?"

   • Buttons:

     • Cancel: Closes the pop-up and remains on the view screen.

     • Proceed: Opens a Comment Entry Pop-Up.

1. Step 4: Success Page

   • Message: "Attendance approved"

   • Action: view another registers or go back to home.

Overview: Enables supervisors to view attendance registers filtered by selected boundaries (e.g., district).

Interface Elements:

User Actions Flow:

1. Select Boundary: Choose a district from the dropdown.

2. Apply Filter: Click "Apply" to filter results.

3. View Results: Access filtered attendance registers for the selected district.

API Endpoints: