My Microplan
Overview
This page displays a tailored list of microplans that the logged-in supervisor is tagged to. Supervisors can manage these microplans within their jurisdiction, ensuring campaign activities are effectively tracked and validated.
Key Features:
Microplans Access: Supervisors will see a list of microplans they are tagged to. This ensures that supervisors can only view and manage the microplans relevant to their role and responsibilities.
filterUniqueByPlanConfig Parameter: The
filterUniqueByPlanConfig
parameter is used here to return all the microplans associated with the logged-in supervisor. This guarantees that only relevant data is displayed.Jurisdiction-Based Access: Supervisors have jurisdiction based on the hierarchy they belong to. For example, a district-level supervisor can access microplans for their district, while a province-level supervisor can access microplans specific to their province.
Sample Hierarchy
Administrative Boundary
Hierarchy
Highest Boundary
Country
Lower Levels
Province, District, Admin Post, Locality ( Lower Level Boundaries)
Interface Elements
Header Section
Title: My Microplans represents the section for managing microplans.
Tabs:
All: Displays all microplans.
Completed Setup: Lists microplans with finalized setup.
Validation in Progress: Microplans undergoing validation.
Microplan Finalised: Displays finalized microplans.
Search Functionality
Search Bar: Allows filtering microplans by name.
Clear Button: Resets the name search to display all microplans.
Microplan Table
The table lists the microplans in a tabular format. Each row represents a microplan, and the columns provide detailed information:
Column Name
Description
Name of Microplan
The unique identifier or descriptive name of the microplan.
Status
Indicates the current stage of the microplan (e.g., "Completed Setup," "Validation in Progress").
Campaign Disease
Specifies the target disease for the campaign (e.g., Malaria).
Campaign Type
Describes the nature of the campaign (e.g., "Bednet Campaign," "SMC Campaign").
Distribution Strategy
Outlines the delivery strategy (e.g., "Fixed Post & House-to-House," "Fixed Post").
Action
Provides actionable options, such as starting validation, editing, or downloading estimations.
Actions for Each Microplan
Status
Action
Description
Completed Setup
Start Validation
Initiates the validation process for the selected microplan.
Validation in Progress
Edit
Opens the microplan for modifications.
Microplan Finalised
Download Estimations
Allows downloading estimated data related to the finalized microplan.
Process Steps
Step 1: Access My Microplans
Objective: View and manage microplans.
Process: Navigate to the My Microplans section.
Outcome: A list of all microplans is displayed, with tabs for status-based filtering.
Step 2: Search for a Microplan
Objective: Locate a specific microplan.
Process: Use the search bar to input the microplan name. Click Clear to reset the search.
Outcome: Filtered results display matching microplans.
Step 3: Perform Actions
Based on the status, perform the following actions:
Completed Setup: Click Start Validation to begin validating the microplan.
Validation in Progress: Click Edit to modify the microplan details.
Microplan Finalised: Click Download Estimations to save related data.
Endpoints
Endpoint
Description
Role
/plan-service/employee/_search
Searches for employee assignments related to microplans.
The filterUniqueByPlanConfig
parameter is used here to return all the microplans associated with the logged-in supervisor. This guarantees that only relevant data is displayed.
MICROPLAN_ADMIN, ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_PLAN_ESTIMATION_APPROVER, PLAN_ESTIMATION_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER, MICROPLAN_VIEWER
/plan-service/config/_search
Fetches plan configurations based on the provided IDs.
SUPERUSER, MICROPLAN_ADMIN, MICROPLAN_CAMPAIGN_INTEGRATOR, ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_PLAN_ESTIMATION_APPROVER, PLAN_ESTIMATION_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER, MICROPLAN_VIEWER
/project-factory/v1/project-type/search
Retrieves campaign details for specific project types based on their IDs.
MICROPLAN_ADMIN, ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_PLAN_ESTIMATION_APPROVER, PLAN_ESTIMATION_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER, MICROPLAN_VIEWER
Last updated