Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Below are the configurations needed for successfully running the supervisor flow
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Click below to access the document:
Health campaign microplanning is a detailed planning approach used to ensure that health interventions, such as immunisations or disease prevention campaigns, are effectively delivered to target populations.
Microplanning helps to know:
Who needs the intervention?
Where is the intervention needed?
How many resources (medical supply, people, commodities, etc.) are needed for the intervention?
How will we reach the intervention site?
Prone to Errors: The process relies heavily on Excel, requiring meticulous care for resource estimation calculations, making it highly susceptible to errors.
Fragmented Management: Each district manages its microplan individually, leading to a back-and-forth process for collaboration. Incomplete data from any district results in faulty resource estimation for the entire campaign.
Complex Data Collection: Gathering and validating population data for microplan estimation is a tedious and poorly defined process. Incorrect population estimates can lead to inaccurate resource estimations for the campaign.
Time-Consuming Collaboration: Microplanning involves multiple people from various administrative levels to administer and validate resource estimations. Offline collaboration is time-consuming and increases the risk of errors if not managed carefully.
Lack of Reusability: Microplan estimations are created from scratch for each new campaign, making the process lengthy and time-consuming without the benefit of reusing previous plans.
Build capabilities that help maximise campaign coverage, enhance access for health campaigns and fairly estimate resources for microplaning. These can be achieved by the following:
Improve population denominator: Leverage data triangulation from multiple sources and validation from community leaders at village/settlement level to identify and improve population denominator.
Targeted Interventions: Leverage data to pinpoint high-risk and unsettled areas and tailor campaign strategies to specific geographic populations.
Optimized Resource Allocation: Analyze population distribution and resource needs to ensure efficient deployment of personnel, vaccines, and supplies.
Improved Outreach & Accessibility: Identify underserved communities and map optimal routes for campaign teams, maximizing outreach and access.
Increased Transparency & Accountability: Provide a clear picture of campaign coverage and resource distribution, promoting accountability to stakeholders and communities.
Enable countries to be able to collect and validate accurate population data for better & accurate microplan estimation.
Enable countries to have better accountability mechanisms and controlled access to ensure transparency and authorised access for microplan execution.
Enable countries to more accurately estimate and distribute resources, ensuring targeted regions are reached and health campaigns are executed smoothly.
To reduce the time to set up and finalise a microplan from an average of 3 months to 1 month.
Set up & manage microplan
Capture campaign details & administrative boundary
Manage microplan data: Top-down population & facility data ingestion
Configure microplan assumptions & estimation formula
Create microplan users & manage their access
Re-use existing microplan
Validate & finalise population data for microplanning
Validate top-down ingested population data of the villages
Edit & update ingested population data of the villages
Approve or reject updated/edited population data of the villages
View status logs and user comments whenever population data is updated
Finalise the microplan population data for the campaign region
Assign facilities or point-of-services to their catchment areas
View the list of facilities belonging to the user’s jurisdiction
Assign the catchment areas under the user’s jurisdiction to the facilities for service delivery
De-assign the already assigned catchment areas under the user’s jurisdiction
Finalise the facility-to-boundary mapping for the campaign region
Validate & finalise the microplan estimation
Validate microplan estimation
Approve or reject microplan estimation
View status logs, change logs, and user comments whenever microplan estimation gets updated
Finalise the microplan estimation for the campaign region
Download and view the finalised microplan as an Excel
Geospatial view of microplan estimation
View the microplan estimation for catchment boundaries on the geospatial map
View the resource estimation for facilities on the geospatial map
View the geospatial map with multiple base map layers
To learn more about the Health Campaign Management (HCM) product, click here.
Set up and manage microplan
Capture campaign details and administrative boundary
Manage microplan data: Top-down population and facility data ingestion
Configure microplan assumptions and estimation formula
Create microplan users and manage their access
Re-use existing microplan
Validate and finalise population data for microplanning
Validate top-down ingested population data of the villages
Edit and update ingested population data of the villages
Approve or reject updated/edited population data of the villages
View status logs and user comments whenever population data is updated
Finalise the microplan population data for the campaign region
Assign facilities or point-of-services to their catchment areas
View list of facilities belonging to the user’s jurisdiction
Assign the catchment areas under the user’s jurisdiction to the facilities for service delivery
De-assign the already assigned catchment areas under the user’s jurisdiction
Finalise the facility-to-boundary mapping for the campaign region
Validate and finalise microplan estimation
Validate microplan estimation created by the system
Update microplan assumptions based on area accessibility and security levels
Approve or reject updated/edited microplan estimation
View status logs, change logs, and user comments whenever microplan estimation gets updated
Finalise the microplan estimation for the campaign region
Download and view the finalised microplan as an Excel
There are some known limitations in the current release of the product and the required change requests have been raised to cater to the limitations. Some of the limitations are:
Configuration of microplan assumptions as per the village’s/settlement’s accessibility or security in the estimation dashboard will not be available.
The facility upload sheet will not accept the capacity of a facility as 0.
Configuration of mixed distribution strategy (Fixed post + House-to-House) will not be available.
Upload Data: Upload population and facility data required for census data approval, facility catchment and resource estimates. This data can be provided in the format of .xlsx (Excel)
Note: While uploading data, it is important to note that location coordinates (latitude and longitude) are not mandatory for microplanning.
Assumptions Configuration:
Assumptions Configuration: Configure assumptions essential for the microplanning estimation processes. These assumptions might include demographic factors, resource availability, and operational constraints.
Formula Configuration:
Set up the formulae to calculate estimated resources, such as human resources, commodities, and budgets. This includes human resources, commodities, and budgets.
Activity Management: Define and manage the sequence and dependencies of activities required for a campaign.
Resource Estimation: Saves the necessary resources for each activity, ensuring that all required materials and personnel are planned.
Condition Monitoring: Set and monitor conditions that must be satisfied for activities to commence, ensuring the right prerequisites are met.
Target Setting and Tracking: Define performance targets against these metrics to ensure campaign goals are met.
Output Generation:
Generate and save microplans.
Hierarchical Assignment: Assign employees to roles based on different hierarchy levels (e.g., Province, District, or Village).
Role Definition: Specify roles for employees, such as PLAN_ESTIMATION_APPROVER
, to clearly define their responsibilities within the microplanning process.
Jurisdiction Mapping: Link employees to one or more jurisdictions, ensuring operational clarity for each role and its geographical coverage.
Plan Configuration Association
The planConfigurationId
links the facility mapping to a specific plan, allowing resources and operations to align with the corresponding microplanning requirements.
Facility Details
The facilityId
uniquely identifies a facility (e.g., health center, warehouse), providing precise mappings for service delivery or logistical purposes.
Residing and Service Boundaries
Residing Boundary: Defines the geographical location or administrative boundary where the facility resides.
Service Boundaries: Specifies the areas serviced by the facility, supporting multi-boundary coverage.
Custom Metadata (Extensibility)
The additionalDetails
field allows for capturing detailed metadata about the facility, such as:
Facility type (e.g., "Warehouse").
Operational status (e.g., "Permanent").
Resource capacities (e.g., "Capacity: 500").
Fixed post status and population served.
File Parsing and Resource Estimation:
The service processes multiple file formats (Excel, Shapefiles, GeoJSON) to estimate the resources required for a microplanning campaign.
It reads the input data, applies predefined assumptions and formulas, and calculates the necessary resources.
Triggers for Plan-Facility Creation, Census Data Creation, and Plan Generation:
Plan-Facility Creation Trigger: When a facility file is uploaded, the service triggers the Plan-Facility Creation API from the project-factory
. This ensures that the facilities are created based on the file contents.
Census Data Creation Trigger: When a population file is uploaded, the service triggers the Census Data Creation process. This involves reading the population file, processing the data, and updating the system with the relevant census information.
Plan Generation Trigger: After the census data is approved, the service reads the updated population file, updates the census data, and triggers the resource estimation and microplan generation based on the latest data detailing the necessary resources and their distribution for the campaign.
Resource Mapping:
The service enriches the mapping of resource columns from the data upload to a predefined set of attributes required for each campaign. This ensures the resources are aligned with the necessary specifications.
Upload Updated Result Sheet:
After the microplan is created and have gone through the estimation approval process, the updated approved resource estimations sheet is uploaded to the filestore and updated back into the plan configuration ensuring the latest version of the resource data is securely stored and accessible.
HCM Console Integration:
The service integrates with the HCM Console, updating the project factory with the estimated resources. This ensures that the project factory always has the most accurate and up-to-date resource requirements for effective campaign planning and execution.
The Census Service provides core functionalities for managing census data and integrating with Plan Service to support advanced microplanning and resource allocation:
Census Record Creation:
Enables creation of census records for specific boundaries.
Supports categorization of records by population type (e.g., people, animals, plants, or others).
Demographic Data Handling:
Facilitates storage of population data categorized by demographic variables (e.g., age, gender, ethnicity).
Allows detailed population distribution to be stored, enabling advanced analysis and planning (e.g., if categorizing by age : {"0-14": 10000, "15-24": 8000}).
Boundary and User Validation:
Validates boundaries for census operations via the Boundary Service.
Verifies user roles for census actions, ensuring compliance with campaign and boundary rules.
Automatically manages census record validity periods, updating timeframes for new campaigns.
Integration with Plan Service:
Works with the Plan Facility API to map facilities to boundaries, ensuring targeted resource allocation and seamless integration between Census and Plan Services.
This service ensures precise demographic analysis, maintains data integrity, and integrates effectively with resource planning processes.
Plan
/plan-service/plan/_create
Create microplan
/plan-service/plan/_search
Search for microplans
/plan-service/plan/_update
Update microplans with resources, targets etc.
/plan-service/plan/bulk/_update
Bulk updates microplans for a workflow action
Plan configuration
/plan-service/config/_create
Create plan configuration with files, assumptions, hypothesis' and resource mappings
/plan-service/config/_search
Search for plan configurations
/plan-service/config/_update
Update plan configurations
Plan employee
/plan-service/employee/_create
Creates assignment mapping between plan and employee
/plan-service/employee/_search
Searches assignment mapping between plan and employee
/plan-service/employee/_update
Updates assignment mapping between plan and employee
Plan facility
/plan-service/facility/_create
Creates assignment mapping between plan and facility
/plan-service/facility/_search
Searches assignment mapping between plan and facility
/plan-service/facility/_update
Updates assignment mapping between plan and facility
Census
/census-service/_create
Creates census records for a particular boundary
/census-service/_search
Searches census records
/census-service/_update
Updates census records
/census-service/bulk/_update
Bulk updates census records for a workflow action
This user manual is designed to guide system admins, population data approvers, facility boundary assigners, and microplan estimation approvers to use Microplanning for health campaigns.
System administrator - This user is responsible for setting up the microplanning platform, such as selecting campaign boundaries, setting up the data, configuring the microplan assumptions, etc. This user will belong to the national/country-level administrative hierarchy.
Population data approver - This user will have access to the microplan module to view, validate, and approve the population of the assigned jurisdiction such as province, district, etc. The approved population will be used for the estimation of resources of the microplan.
National population data approver - This is a national/central level population data approver who will have access to approve and finalise the population data for the villages/settlements within the campaign boundary.
Facility boundary assigner - This user will have access to the microplan module to assign the facilities to their catchment boundaries concerning the user’s assigned jurisdiction such as province, district, etc.
National facility boundary assigner - This is a national/central level user, who will have access to the microplan module to assign the facilities to their catchment boundaries and finalize the facility to catchment area assignment for the villages/settlements within the campaign boundary.
Microplan estimation approver - This user will have access to the microplan module to view, edit, and approve the microplanning estimation concerning the user’s assigned jurisdiction such as province, district, etc.
National Microplan estimation approver - This is a national/central level user, who will have access to the microplan module to view, edit, and approve the microplanning estimation and finalize the microplan estimation for the villages/settlements within the campaign boundary.
System role involved: System Administrator
First, select the language before you can log in. Currently, three languages are supported:
English
Portuguese
French
Select the preferred language and click on 'Continue' to go to the login page.
(Note: Getting an account on HCM Microplanning: The implementation team will create the account for the system admin and the admin will be provided with a username and password to log into the account).
On the login page, enter the 'Username', 'Password', and the 'City' you are working in to log in to HCM Microplanning.
Once you log in, you will be landing on the homepage to take the next action.
Once you land on the homepage, you will see 3 different actions to choose from:
Set Up Microplan: This is the capability that you will use to set up the microplan for a health campaign.
Open Microplans: This is the capability that you will use to view the drafted and already created microplans.
User management: You will use this capability to register the users with different roles that are part of the microplanning process.
If this is the first time a microplan is being set up, you must create the users who will be primarily working on the different microplanning activities.
As a system administrator:
You must click on the "User Management" module to start with.
Once you click on the "User Management" module, you can see the list of users who are already registered for different microplanning roles. The user details that you will be able to see are:
Name: Name of the microplanning user
Email: Email ID of the microplanning user
Contact Number: Contact number of the microplanning user
Role: The role that is assigned to the microplanning user
This is the dashboard view that you will get once you land on the user management module. If this is a first-time setup, there will be no user details available in the dashboard.
You can search users using the ‘Name’ or ‘Contact Number’ search fields.
You can filter out some users belonging to a role using the role filter available in the dashboard.
If you need to add new users to the microplanning module, then click on the "Bulk Upload Users" feature.
In the bulk upload user page, you can see a button called "Download Template", which will be used to register new users to the microplanning module.
Once you click on the ‘Download Template’ button, you will be able to download an Excel sheet that you will use to enter the new user details that are part of the Microplanning module.
The content of the template are:
Read me: This sheet will have the details of how to fill the user template Excel and upload it for user registration.
User roles: This sheet will have the list of roles available for user registration and the description of each role.
Role mapping for each sheet: There will be a sheet defined in the template for each role available. Inside each of the role sheets, the system admin can fill in user details with -
- Name: Name of the user who will use the microplanning platform.
- Contact number: Contact number of the person who will use the microplanning platform.
- Email ID: Email ID of the person who uses the microplanning platform.
This is the template structure for adding the new user details.
Once the template is filled, you can upload the data and see a success message that the file has been uploaded successfully.
This is the screen that you will see when the template file is successfully uploaded.
This is the screen that you will see when the uploaded template file is successfully submitted.
Once the file is uploaded, you will be able to download the user credentials of the new users who are registered.
This is the capability that you will be able to download the user credentials of the registered users.
Content of the screen:
File name and attachment: This will have the name of the file with a hyperlink to view and download the file.
The downloaded file will have all the details of the file that was uploaded, along with the user login credentials for each of the users in the file.
The downloaded file will have the login credentials that were generated by the system itself for the first time when the file was uploaded and submitted successfully.
File uploaded by: This will show the name of the system administrator who uploaded and submitted the file.
File uploaded time: This will show the timestamp of the file uploaded by the system administrator.
Once the user creation step is completed, you can start with the microplan setup process.
As a system administrator:
Using this screen, you can capture the campaign details for which the microplanning needs to be done. The components of this screen are -
Disease identified for the campaign - By default ‘Malaria’ will be chosen as we are creating the microplanning for the assumptions of malaria. As and when new diseases come into the picture, we will add those diseases in the dropdown.
Type of campaign - Upon choosing the disease, you will be asked to choose the campaign type, which is either ‘Bednet’ or ‘SMC’. As and when new campaign types come into the picture, we will add those campaign types in the dropdown.
Resource distribution strategy - Upon choosing the campaign type, you will be asked to choose the distribution strategy, which is either ‘Fixed post’ or ‘House-to-House’ or ‘Fixed post & House-to-House’. Depending on the strategy chosen, the assumptions and resource estimation formula will be auto-configured in the platform.
Once you have chosen the required details, you can click on the "Save and Proceed" button to move to the next screen.
This is the screen that you will use to fill in the campaign details.
Using this screen, you can view the details of the campaign for which the microplanning needs to be done, and the user will be able to name the microplan accordingly for further use. The components of this screen are -
Campaign details - The campaign basic details chosen in the previous screen such as campaign disease, campaign type, and resource distribution strategy will be shown here.
Naming of microplan - The microplan name will be auto-suggested by the system. The structure of the microplan name is "Disease-CampaignType-Resource distribution strategy-MonthLast2digitsOfYear". The name is a suggested name and you can edit the microplan name if required. It’s a mandatory field.
Microplan naming format - This segment talks about the criteria for creating a microplan name if you want to self-create a microplan name. The naming conventions are:
- The name should be a minimum of 3 characters in length
- Only numeric values are not allowed
- Special characters -, _, (, ),& are only allowed
Once you have finalised the microplan name, you will have to click on the "Save and Proceed" button to move to the next screen.
This is the screen that you will use to edit and finalise the microplan name.
Once you have finalized the microplan name and campaign details, you will not be allowed to edit the campaign details if you save the details and move to the next screen.
You will see a warning pop-up to confirm if you want to save and move to the next screen:
This is the warning pop-up that you will see before you move to the next screen.
This step will let you select the existing boundary data in the system. (This is a mandatory field for moving to the next screen). The boundary data will have to be set up in the system beforehand at the time of instance creation and the same boundary data should be reused by the user for all campaigns in a given instance.
(Note: If you have not selected boundaries, you will not be allowed to move on to the next steps. For example: If the boundary data is set up for Mozambique, the user will see the whole boundary mapping for Mozambique that is available on the system. If there is a need for change, we will provide the contact information for the support team to update the boundary and the support team will update the boundary data).
The boundary selection for a campaign will happen through a mapped checkbox field as shown below. There is a drop-down-based selection for each level of the hierarchy:
This is the boundary selection screen that you will need to configure.
If a given boundary is selected in one level of the hierarchy, the next level will show boundaries mapped to only the ones selected in the previous level. You will not be able to make any selection at a given level without selecting the boundaries in the level above.
After you have selected the boundaries, click on the "Save and Proceed" button.
Here, you will set target and total population data for the microplan by default at the lowest level of the administrative hierarchy boundaries. This will be achieved by an Excel upload as explained below:
To set target and total population data, click on “Download Template” on this screen. You will download the template having all the boundaries in Excel with an empty column for setting population data.
Note: Each campaign will have its target-setting template: For example, the bednet campaign will have its template, and the SMC campaign will have its template.
The first tab/sheet will be the “Read Me” tab and will have the information on how you can set the targets for each village selected in the boundary selection screen.
The district-wise sheets will have the following structure:
Note: All the villages in the Excel will be listed based on the district they belong to, with one tab for each district having a list of the villages under them. For example, if you have selected 20 districts, you will see 20 tabs (one for each district) having all the villages belonging to that particular district.
You must adhere to the guidelines while entering the population data and uploading it for the microplanning estimation. The guidelines are below for population data upload -
The mandatory fields such as total population and target population data must be a whole number (For example, population can be 1234 and not 123.5)
The Latitude & Longitude fields should have data in Degree Decimal and Degree Minute Seconds (Value should be 12.3455 & not 12° 20' 43.7994")
Some of the validation you need to take care of while uploading the population Excel file:
You can’t upload a file with empty population data for one or more villages in the sheet
The population data for a village must be a whole number, else the file will not be uploaded
You can’t delete any of the columns in the file before uploading it
You can’t change the column structure in the file before uploading it
You can’t delete any of the sheets in the Excel before uploading it
You can’t upload a file with negative population data for a village in the sheet
You must adhere to the standard structure of the latitude & longitude before you upload the file with the latitude and longitude of the villages
Once you have uploaded the population data, click on "Save and Proceed" to move to the facility upload page.
This screen will be used for uploading the population data.
This screen shows the validation when the population file is uploaded successfully.
Once the population file is uploaded, you need to upload the facility sheet to configure the facilities that will be used in the microplanning process.
To configure the facility data for the microplan, you will have to download the facility upload sheet using the ‘Download Template’ button.
If you already have a facility registry set up in the instance where the microplan is getting configured, those facilities will be pre-populated in the downloaded template. You can also add new facilities in the template, which will be considered for the current microplan.
The facility template structure is below:
The facility template will have 3 different Excel sheets:
- Read me: This will help you know the steps to configure the facilities required for microplanning.-
- List of available facilities:
Facility Name: If the instance already has facilities defined, then you will be able to see the names of the facilities that are existing.
Facility Type: If the instance already has facilities defined, then you will be able to see the type of facilities that are linked to each facility. The facility type for an instance will be defined in the MDMS during instance creation.
Facility Status: If the instance already has facilities defined, then you will be able to see the status of the facilities that are existing. The facility status for an instance will be defined in the MDMS during instance creation.
Capacity: If the instance already has facilities defined, then you will be able to see the capacity of the facilities that are existing. The definition of capacity of the facility is defined in the MDMS during instance creation.
Facility usage: If the instance already has facilities defined, then you will be able to see the usage status of the facilities that are existing. ‘Active’ usage status means the facility is operational for the campaign and ‘Inactive’ usage status means the facility is non-operational for the campaign. The usage status is defined in the MDMS during instance creation.
Serving population per campaign: This will define the total population that can be served by the facility in a campaign.
Is fixed post?: If the instance already has facilities defined, then you will be able to see if the facilities will be catered as a fixed post. The fixed post tag will only be functional when the resource distribution strategy is either Fixed post or House-to-House & Fixed post (Mixed). For instance, the fixed post tag will be defined for a facility unless it is manually changed by the user.
Residing boundary code: The residing boundary code defines where exactly the facility resides. The user can tag the boundary where the facility resides using the residing boundary sheet. The residing boundary of the facilities will be saved for the instance and it can be changed as per the user’s requirement during the facility configuration. This will be a dropdown option.
Latitude & Longitude: Here the user will be asked to enter the latitude & longitude of the facility to be shown on the map. This is optional data.
- Boundary data: This sheet will give you the administrative boundary where the microplan is being set up. This will also give the boundary codes for each administrative boundary, which can be used for tagging the facilities to their respective boundaries.
You must adhere to the guidelines while entering the facility data and uploading it for the microplanning estimation. The guidelines are below for population data upload -
All the fields are mandatory and can't be empty, except the Latitude and Longitude fields
The Latitude & Longitude fields should have data in Degree Decimal and Degree Minute Seconds (Value should be 12.3455 & not 12° 20' 43.7994")
Some of the validation you need to take care of while uploading the population Excel file:
You must fill in all the mandatory fields before uploading the facility Excel file
For all the values of each column of data, you must choose the value from the dropdown to upload the Excel file
You can’t delete any of the columns in the file before uploading it
You can’t change the column structure in the file before uploading it
You can’t delete any of the sheets in the Excel before uploading it
You can’t upload a file with negative facility capacity for a facility in the Excel sheet
You must adhere to the standard structure of the latitude & longitude before you upload the file with the latitude and longitude of the villages
You must choose the correct facility residing code, from the Boundary code sheet, for tagging the facility to its boundary
Once you have uploaded the facility template, click on "Save and Proceed" to move to the facility upload page.
This screen will be used for uploading the facility data.
This screen shows the validation when the facility file is uploaded successfully.
Once the data management step is completed, you will be directed to the microplan assumption module.
Here, you will be asked some preliminary questions, the answers to which will provide an ideal estimate assumption form for you.
This is the screen for answering the preliminary questions.
Since you have chosen the resource distribution strategy as "House-to-House & Fixed post", you will have to answer the following questions:
How is the campaign registration process happening?
How is the campaign distribution process happening?
You can choose either House-to-House or Fixed post and depending on what you have selected, the microplan assumptions will be configured on the next page accordingly.
Here, once the previous questions are answered, you will move to the microplan assumption page to enter the microplan assumptions as per the campaign requirements.
This is the screen for entering the general assumptions for the microplan.
This is the screen for entering the registration assumptions for the microplan.
This is the screen for entering the distribution assumptions for the microplan.
This is the screen for entering the commodities assumptions for the microplan.
This is the screen for entering the vehicle assumptions for the microplan.
Here is the sheet containing the information for all the assumptions as per the campaign type and the distribution strategy:
All the assumptions shown above are configured as per the campaign type and distribution strategy chosen.
You can add a new assumption, if required, using the "Add assumption" button.
You can delete the already configured assumptions, if required, using the ‘Delete’ button beside the assumption.
Once all the assumptions are configured, click on "Save and Proceed" to move to the next section of the microplan formula configuration.
Once the assumptions are configured, you will be moved to the microplan formula configuration.
Here, you will be able to see the formulas that are pre-configured for the campaign type and distribution strategy chosen.
And you must configure the microplan assumptions properly as the formulas will be dependent on the assumptions you have configured.
This is the screen for viewing the general estimations formula.
This is the screen for viewing the registration estimations formula.
This is the screen for viewing the distribution estimations formula.
This is the screen for viewing the commodities estimations formula.
This is the screen for viewing the vehicle estimations formula.
Here is the sheet containing the information for all the estimation formulas as per the campaign type and the distribution strategy:
All the estimation formulas shown above are configured as per the campaign type and distribution strategy chosen.
You can add a new estimation formula, if required, using the "Add formula" button.
You can delete the already configured estimation formula, if required, using the ‘Delete’ button beside the pre-configured formula.
Once all the estimation formulas are configured, click on "Save and Proceed" to move to the next section of user access management.
Once the formula configuration has been completed, you will be moved to the user access management for configuring the users who will be performing the microplanning activities.
Here, you can choose and attach the selected users to the microplan.
This screen is for adding the users belonging to the ‘National Microplan estimation approver’ to the microplan using the "Assign National Microplan Estimation Approver" button.
This is the pop-up that you will use to search for the user to whom you want to assign the microplan.
This screen shows the users with the "National microplan estimation approver" role you added to this microplan. You can also un-assign the assigned users from the microplan using the ‘Unassign’ button.
This screen is for adding the users belonging to the "National facility boundary assigner" to the microplan using the "Assign National Facility Boundary Assigner" button.
This is the pop-up that you will use to search for the user to whom you want to assign the microplan.
This screen shows the users with the "National facility boundary assigner" role you added to this microplan. You can also un-assign the assigned users from the microplan using the ‘Unassign’ button.
-------------------------------------------------------------------------------------------------------------------
This screen is for adding the users belonging to the "National population data approver" to the microplan using the "Assign National Population Data Approver" button.
This is the pop-up that you will use to search for the user to whom you want to assign the microplan.
This is the screen that shows the users with the "National population data approver" role that you have added to this microplan. You can also un-assign the assigned users from the microplan using the ‘Unassign’ button.
This screen is for adding the users belonging to the "Microplan estimation approver" to the microplan using the ‘Assign Microplan Estimation Approver’ button.
This is the pop-up that you will use to search for the user to whom you want to assign the microplan.
This is the screen that shows the users with the "Microplan estimation approver" role that you have added to this microplan. You can also un-assign the assigned users from the microplan using the ‘Unassign’ button.
This screen is for adding the users belonging to the "Facility boundary assigner" to the microplan using the "Assign Facility Boundary Assigner" button.
This is the pop-up that you will use to search for the user to whom you want to assign the microplan.
This screen shows the users with the "Facility boundary assigner" role you added to this microplan. You can also unassign the assigned users from the microplan using the ‘Unassign’ button.
This screen is for adding the users belonging to "Population data approver" to the microplan using the "Assign Population Data Approver" button.
This is the pop-up that you will use to search for the user to whom you want to assign the microplan.
This is the screen that shows the users with the "Population data approver" role that you have added to this microplan. You can also un-assign the assigned users from the microplan using the ‘Unassign’ button.
Now that you have assigned the required users to the microplan, you can click on "Save and Proceed" to go to the next and final phase of the microplan setup.
You are now at the last leg of setting up the microplan.
In the summary screen, you can view all the tabs and make edits before finalising the microplan setup.
This summary screen shows you all the tabs of microplan configuration.
This is the finalised microplan setup screen. Once the microplan setup is done, you cannot make any changes in the microplan. Now the microplan is ready for the next set of activities to be executed.
Here, you will click on "Open Microplan" to view the list of the microplans that are either in created or in drafted status.
The microplan can be in any of the following statuses at a time:
Drafted: This status indicates that the microplan is partially configured and the setup isn’t completed yet.
Completed setup: This status indicates that the microplan setup has been completed and now the microplanning activities can be started.
Validation in progress: This status indicates that the microplan validation process has started.
Microplan finalised: This status indicates that the microplan estimation has been finalised and completed.
The dashboard has a total of 6 columns:
Name of the microplan: It indicates the name of the microplan
Status of microplan: It indicates the current status of the microplan
Campaign disease: It indicates the campaign disease for the microplan
Campaign type: It indicates the type of the campaign for the microplan
Distribution strategy: It indicates the distribution strategy of the campaign for the microplan
Action: It indicates the action that can be taken in the microplan.
Available actions are -
Edit microplan: If the microplan status is drafted, you can edit the microplan before finalizing it.
View summary: If the microplan setup is completed, you can only view the summary of the microplan. You will not be able to edit the microplan.
Download: If the microplan estimation is finalised, you can download the microplan estimation in Excel format.
This is the view of the ‘Open microplan’ dashboard.
Step 2 - How will the population data be validated and approved for microplan estimation?
System role involved: National population data approver, Population data approver
You must first select the language before you can log in. Currently, 3 languages are supported for the HCM Microplanning platform. They are:
English
Portuguese
French
Select the preferred language and click on 'Continue' to go to the login page.
(Note: Getting an account on the HCM Microplanning platform: The microplanning users with different roles will have their account created by the system admin and will be provided with a username and password to log in to the account).
On the login page, enter the 'Username', 'Password', and the 'City' you are working in to log in to the HCM Microplanning platform. You need to use the login credentials belonging to the ‘Population data approver’ or ‘National population data approver’ roles.
Once you log in, you will be landing on the homepage to take the next action.
Once you are on the home page, you will be able to see the "My Microplan" segment.
This is the view of the "My Microplans" segment.
By clicking the "My Microplan" segment, you will be able to see the list of Microplans that you are part of.
This is the dashboard that will show you the list of microplans assigned to you.
The data points that are available on this dashboard are:
Name of Microplan: This field will show you the name of the microplan assigned to you.
Status: This field will show the status of the microplans assigned to you. A microplan can be in either of the following statuses:
- Completed setup: This status means that the assigned microplan setup is completed and it’s ready for validation activities.
- Validation in progress: This status means that the assigned microplan is being validated by the assigned microplanning users.
- Microplan finalised: This status means that the assigned microplan’s estimation has been reviewed and finalized by the validation team.
Campaign Disease: This field will show you the campaign disease for which the microplan was set up.
Campaign Type: This field will show you the type of campaign for which the microplan was set up.
Distribution Strategy: This field will show you the distribution strategy that is considered for the campaign assigned to the microplan.
Action: This button will let you take the set of actions you want to perform in the selected microplan.
You can also search a microplan using the ‘Microplan Name’ search on top.
Once you choose the microplan on which you want to act, you will be redirected to an activity selection screen.
This is the view for the activity selection screen.
Once here, if you are logged in as a "Population data approver" role, you will have to click on the "Validate & Approve Population Data" tab. The population data will refer to the top-down uploaded population data by the system administrator while setting up the microplan.
This is the first and the critical step, without the validation and finalization of the population data, you will not be able to move ahead with other activities.
You will click on the "Validate & Approve Population Data" tab, and you will be redirected to the population validation page where you need to validate the population for each village or settlement under your jurisdiction.
This is the view for the population validation screen.
In this dashboard you will be able to see:
- List of villages that are assigned to you and others for validation. You can filter out the villages that are assigned to you and others by using the tabs "Assigned to me" and "Assigned to all".
- List of villages as per their validation status. You can filter out the villages with different statuses such as:
Pending for validation: This status shows the list of villages under your jurisdiction and has not been validated yet.
Pending for approval: This status shows the list of villages under your jurisdiction and has not been approved yet. You will only see villages in this status if any of your subordinates have updated the target or total population data for the villages under their jurisdiction and they have sent the villages to you for approving the changes made.
Validated: This status shows the list of villages under your jurisdiction and has been validated either by you or your subordinates or your supervisors.
- You can also filter out the villages concerning their administrative hierarchy and administrative area using the filters available at the top.
- In the village details, you will be able to see:
Village name: This indicates the name of the villages assigned.
Assignee: This indicates the name of the person responsible for validating the village population data.
Uploaded total population: This indicates the total population data that was uploaded by the central team or system administrator while setting up the microplan.
Confirmed total population: This indicates the total population data for the village, which will be used for microplan estimation. Here, the uploaded total population will be the same as the confirmed total population.
Uploaded target population: This indicates the target population data that was uploaded by the central team or system administrator while setting up the microplan.
Confirmed target population: This indicates the target population data for the village, which will be used for microplan estimation. Here, the uploaded target population will be the same as the confirmed target population.
Status logs: This indicates the status of each village (Validated, Sent for correction, or Approved), who changed the status, at what time the status was changed and what was the reason for the change.
Note: There will be a couple more columns such as confirmed and uploaded target population as per age groups for the SMC campaign.
This is the view of the status logs.
Now, if you agree to the confirmed population data in this dashboard, you will have to choose the villages and click on the ‘Validate’ button to validate the village population data.
Once you click on the ‘Validate’ button, you will be asked to enter a comment/reason for validation. This is non-mandatory and can be made mandatory depending on the microplan requirement.
This is the screen for validating the village population data.
This is the pop-up for adding a reason/comment of validation. Adding a reason/comment is non-mandatory.
In case you aren’t aligned with the confirmed population data of the village, you can click on the ‘edit’ button beside the confirmed population data to update it.
Once you update the confirmed population data, that particular village will move to the "Pending for approval" status of your supervisors to validate & approve the data.
This is the pop-up screen for editing/updating the village population data.
This is the pop-up for adding a reason/comment for sending the data for approval. Adding a reason/comment is non-mandatory.
Now, if you log in with a superior role such as "National population data approver", you will be able to see the villages that are assigned to you for approval.
As a supervisor with a "National population data approver" role, you will be able to take either of the following actions on the villages assigned to you:
You can send back the data for correction: If you are not aligned with the population data update done by your subordinate, you can choose to send back the village data to your subordinate with a valid reason for rejection.
You can approve the changes made in the village population data: If you are aligned with the population data update done by your subordinate, you can choose to approve the data with a reason for approval. Again, adding reason is a non-mandatory step.
This is the screen showing the list of villages that are pending for approval.
This is the pop-up you will get if you choose to send back any village data for correction. Adding the comment/reason is non-mandatory.
This is the pop-up you will get if you choose to approve the village data. Adding the comment/reason is non-mandatory.
Once the villages are validated, you should be able to see them in the ‘Validated’ bucket. Here, if you are not aligned with any of the village data that is validated, you will have the ability to send back the data for correction to the subordinate, who had earlier validated the data.
This is the dashboard showing the villages that are already validated. You get an option to send back any of the villages for correction if you are not aligned with the validated population data.
This is the pop-up you will get if you choose to send back any village data for correction. Adding the comment/reason is non-mandatory.
Once all the villages under your jurisdiction are validated, you should be able to see the villages in the ‘Validated’ bucket. You can go back to the home screen since your activity is completed.
This is the dashboard view when all the villages, under your jurisdiction, are validated.
Here, if all the users assigned to the "Population data approver" role have validated all the villages under their jurisdiction, the user with the "National population data approver" role will get a button called "Proceed To Finalise Population Data" to finalise the population data for the campaign boundaries. Once the population data is finalized, the same population data will be used for the microplan estimations.
This is the view that the "National population data approver" gets once all the villages in his jurisdiction are validated.
This is the pop-up that the "National population data approver" gets once he clicks on the "Proceed To Finalise Population Data" button.
This screen shows that the population data has been finalised for microplan estimation.
You can now click on the ‘Go back to home’ button to go back to the "My Microplans" dashboard, as your assigned activity has been completed.
System role involved: National facility boundary assigner, Facility boundary assigner
You must first select the language before you can log in. Currently, 3 languages are supported:
English
Portuguese
French
Select the preferred language and click on 'Continue' to go to the login page.
(Note: Getting an account on the HCM Microplanning platform: The microplanning users with different roles will have their account created by the system admin and will be provided with a username and password to log in to the account).
On the login page, enter the 'Username', 'Password', and the 'City' you are working in to log in to the HCM Microplanning platform. You need to use the login credentials belonging to the "Facility boundary assigner" or "National facility boundary assigner" roles.
Once you log in, you will be landing on the homepage to take the next action.
Once you are on the home page, you will be able to see the "My Microplan" segment.
This is the view of the "My Microplans" segment.
By clicking on the "My Microplan" segment, you can see the list of Microplans that you are part of.
This is the dashboard that will show you the list of microplans assigned to you.
Once you choose the microplan on which you want to act, you will be redirected to an activity selection screen.
This is the view for the activity selection screen.
Once here, if you are logged in as a "Facility boundary assigner" role, you will have to click on the "Assign Facilities To Villages" tab.
This is the second step, without finalizing the facility-boundary assignment mapping, you will not be able to move ahead with the next activity.
You will click on the "Assign Facilities To Villages" tab, which will redirect you to the facility assignment screen where you will need to assign the facilities under your jurisdiction to their respective catchment boundaries (Example: villages).
This is the dashboard view you will see when you log in as either the "Facility boundary assigner" or "National facility boundary assigner" role.
In this dashboard, you will be able to:
Search and filter facilities as per the "Facility name", "Facility type", "Facility status", and "Administrative area".
Tabular view of data having below points:
Facility Name: This indicates the name of the facility assigned to you.
Facility Type: This indicates the type of facility assigned to you.
Facility Status: This indicates the status of the facility assigned to you.
Capacity: This indicates the storage capacity of the facility. It can be either ‘Bales’ for the LLIN campaign or ‘SPAQs’ for the SMC campaign.
Assigned Villages: This indicates the count of villages that are assigned to the chosen facility.
Serving Population: This indicates the sum of the target population of the villages that will be served by the chosen facility.
Fixed Post: This indicates if the facility is fixed post or not.
Administrative Area: This indicates the administrative boundary to which the facility is mapped.
Assign: Assign indicates that you can either assign some villages or administrative boundaries to the facility for defining the catchment area or you can de-assign the some villages or administrative boundaries that are already assigned to the chosen facility.
You will click on the ‘Assign’ button, which will redirect you to the boundary assignment/assignment dashboard.
Here, you can see 2 different tabs, one that shows the list of villages, that are not assigned to any facility called the ‘Unassigned Villages’ tab, and the other that shows the list of villages, that are already assigned to the chosen facility called "Assigned Villages" tab.
This is the view for de-assigning or assigning the villages to the chosen facility.
In the "Unassigned Villages" tab, you will see the list of villages that are yet to be assigned to a facility for defining their service boundary.
On this page, you can filter out the villages as per their administrative hierarchy and administrative areas from the filter segment above.
You can select one or more villages that can be considered as the catchment boundaries for the chosen facility and then click on "Add to facility" to add the selected villages to the chosen facility.
This is the view that you will get once you choose the villages for the facility assignment.
Once the villages are assigned to the facility, you will be able to see the assigned villages in the "Assigned Villages" tab. The assigned villages define the catchment boundary for the chosen facility.
On this page, you can filter out the villages as per their administrative hierarchy and administrative areas from the filter segment above.
You can select one or more villages that can be de-assigned from the chosen facility. Once de-assigned, the village will not be part of the catchment boundary of the facility anymore. The de-assigned villages can be reassigned to the chosen facility from the "Unassigned Villages" tab.
This is the view that you will get once the villages are assigned to the chosen facility. You can choose to de-assign the villages from this dashboard.
Once all the villages under the campaign boundary are assigned to their catchment or service facilities, then, if you are logged in as a ‘National facility boundary assigner’, you can see a button called "Proceed To Finalise Facility Assignment".
This is the button you will see as a "National facility boundary assigner" once all the villages under the campaign boundary have been assigned to their catchment facility.
If you are logged in as a "National facility boundary assigner", you can see and click on "Proceed To Finalise Facility Assignment" to finalise the facility assignment for the campaign boundary.
Here, once you click on this button, you will be shown a pop-up asking you to verify the facility assignment and then finalize the assignment. Once finalized, you can make any changes to the facility assignment.
This is the warning pop-up you will see when you try to click on the "Proceed To Finalise Facility Assignment"’ button.
Once you click on the button shown in the pop-up called "I Want To Finalise", you will see the activity completion screen showing the facility assignment is completed successfully.
This is the screen you will see when the facility assignment is completed.
You can now click on the "Go back to home" button to go back to the "My Microplans" dashboard, as your assigned activity has been completed.
Step 4 - How will the microplan estimations be validated and approved?
System role involved: Microplan estimation approver, National microplan estimation approver
You must first select the language before you can log in. Currently, 3 languages are supported for the HCM Microplanning platform. They are:
English
Portuguese
French
Select the preferred language and click on 'Continue' to go to the login page.
(Note: Getting an account on the HCM Microplanning platform: The microplanning users with different roles will have their account created by the system admin and will be provided with a username and password to log in to the account).
On the login page, enter the 'Username', 'Password', and the 'City' you are working in to log in to the HCM Microplanning platform. Use the login credentials belonging to the "Microplan estimation approver" or "National microplan estimation approver" roles.
Once you log in, you will be landing on the homepage to take the next action.
Once you are on the home page, you will be able to see the "My Microplan" segment.
This is the view of the ‘My Microplans’ segment.
By clicking on the ‘My Microplan’ segment, you can see the list of Microplans that you are part of.
This is the dashboard that will show you the list of microplans assigned to you.
Once you choose the microplan on which you want to act, you will be redirected to an activity selection screen.
This is the view for the activity selection screen.
Once here, if you are logged in as a ‘Microplan estimation approver’ role, click on the "Validate & Approve Microplan Estimations" tab.
This is the third and final step where the microplan estimation for all the villages under your jurisdiction needs to be validated and finalized for executing the microplan.
Once you click on "Validate & Approve Microplan Estimations", you will be redirected to the dashboard to validate the microplan estimations for the administrative areas under your jurisdiction.
This is the dashboard for validating & approving the microplan estimation for the administrative areas under your jurisdiction.
In this dashboard you will be able to see:
Administrative hierarchy and administrative are filters to filter out administrative areas under a specific administrative hierarchy.
‘Assign to me’ or ‘Assign to all’ filters will show you the list of villages that are yet to be validated by either you, or your subordinates, or your supervisors.
Status filter to filter out the administrative areas or villages as per their status. The filters are:
Pending for validation: This status shows the list of villages under your jurisdiction and has not been validated yet.
Validated: This status shows the list of villages under your jurisdiction and has been validated either by you or your subordinates or by your supervisors.
In the tabular view of the data, you will be able to see the microplan estimation data for all the villages under your jurisdiction. The columns shown in the dashboard will change depending on the campaign type and distribution strategy chosen.
The tabular data will have the list of microplan estimations, for the villages, that need to be validated by either you, or your supervisor, or your subordinate.
Once you have checked the microplan estimations for all the villages under your jurisdiction and if you are fine with the estimation numbers, you can click on the villages that you want to validate and then click on the ‘Validate’ button.
Once you click on the ‘Validate’ button, the selected villages will move away from the ‘Pending for validation’ bucket to the ‘Validated’ bucket.
Any action that you take in the dashboard for a village will be recorded and can be seen by anyone using the "Status logs" button.
This is the view of the dashboard to validate the microplan estimation for the concerned villages.
This pop-up will be shown to you when you click on the ‘Validate’ button. You, as a microplan estimation approver, can enter any comment or reason for validating the microplan estimation for the villages chosen. Entering any comment or reason is non-mandatory.
This is the status logs pop-up showing the status of the village, who made the status change and when was the change recorded.
Once the villages are validated, you can see the list of villages in the ‘Validated’ bucket.
If you log in as a superior administrative hierarchy "Microplan estimation approver" or "National microplan estimation approver" role, you can validate if the villages validated by your subordinates are correct.
If you are not aligned with the validation done by your subordinates, you can always send back the village data for correction to the person who had validated the villages. This can be done using the button called ‘Send back for correction’.
Any action that you take in the dashboard for a village will be recorded and can be seen by anyone using the ‘Status logs’ button.
This is the view of the dashboard for checking the data and sending back the data for correction.
This pop-up will be shown to you when you click on the "Send back for correction" button. You, as a microplan estimation approver, can enter any comment or reason for sending back the village data for correction for the villages chosen. Entering any comment or reason is non-mandatory.
Once all the villages under the approver’s jurisdiction are validated, then, if you are logged in as a "National microplan estimation approver", you will be able to see a button called ‘Proceed To Finalise Microplan Estimation’.
This is the button you will see as a ‘National microplan estimation approver’ once all the villages under the campaign boundary are validated.
If you are logged in as a "National microplan estimation approver", you will be able to see and click on the "Proceed To Finalise Microplan Estimation" to finalise the microplan estimation for all the villages under the campaign boundary.
Here, once you click on this button, you will be shown a pop-up asking you to validate the estimation before you finalise the microplan estimations.
This is the warning pop-up you will see when you try to click on the "Proceed To Finalise Facility Assignment" button.
Once you click on the button shown in the pop-up called "I Want To Finalise", you will see the activity completion screen showing the microplan estimation is completed successfully.
This is the screen you will see when the microplan estimation is finalised.
You can now click on the "Go back to home" button to go back to the "My Microplans" dashboard, as your assigned activity has been completed.
Once the microplan is finalised, you will be able to download the microplan estimations in an Excel spreadsheet.
This is the view where you will see the microplans that are finalised and you will be able to download the microplan estimations using the "Download Estimation" button.
Data upload are to be followed and adhered to
a. Input formats supported:
- Pre-defined Excel template
- Geosjon (pre-defined schema)
- Shapefile
b. Configure data starting from admin 0
c. A naming convention needs to be followed for data upload (training to be provided)
d. 1 file per boundary to be uploaded
- 1 file for all admin 0
- 1 file for admin 1
The GeoJSON file should meet the specification
The top-level element should be of type “FeatureCollection”
All the Features within the FeatureCollection should have geometries of the same type (i.e. All should be points, or all should be MultiPolygons, and so on).
The coordinates should be in the valid range of Latitude & Longitude. (Valid range for Latitude is -90 to +90; Valid range of Longitude is -180 to +180)
If the third coordinate (i.e. the height value) is present, then it will be ignored.
All the features should have properties with the same set of keys.
In the Properties object, the values for fields that represent a Numeric Value, should not be quoted with double quotes, (i.e. population of 10,000 should be represented as “population” : 10000 and not “population” : “10,0000”
A shapefile consists of multiple files with the same name and different extensions. Mandatory ones are .shp, .shx & .dbf. You could also have .prj, .sbx & .sbn.
The shapefile should be in the WGS 84 lat-long coordinate system. (i.e. EPSG:4326). If the .prj file is missing, then the data is assumed to be in the WGS 84 lat-long coordinate system.
Data in any other coordinate system, even if indicated so in the .prj file will not be considered valid.
The coordinates should be in the valid range of Latitude & Longitude. (Valid range for Latitude is -90 to +90; Valid range for Longitude is -180 to +180).
Field Names are limited to 10 Characters as per the Shapefile Specification.
The Various fields in the attribute table should have the appropriate data types. (i.e. Numeric Values should be in fields of the type Short Integer, Long Integer, Float, or Double)
The User should zip up all the files in Zip format, and upload them into the system. At a minimum, the system needs .shp, .shx & .dbf files
The total size of all files together should not exceed 2GB
The Latitude & Longitude fields should have data in Degree Decimal and Degree Minute Seconds ( Value should be 12.3455 & not 12° 20' 43.7994")
Any leading & trailing whitespace characters (Spaces, Tabs, Carriage Return, new line etc) will be stripped out from all fields
plan-service-db:v1.0.0-717aeac28f-231
0.1 tag added
resource-generator:v1.0.0-3f860f8a31-29
0.1 tag added
census-service:v1.0.0-fd9a00f0e7-77
0.1 tag added
microplan-ui:v0.3.0-6f6f7d5a6a-386
0.1 tag added
HCM Admin Console v0.3
project-factory:console-49b5801640-252
updated
workbench-ui:v0.3.0-9c780fe20f-703
updated
HCMv1.5
health-project:v1.1.5-8208b6fc8f-69
updated
Health-HRMS
Health-HRMS
health-hrms:hrms-changes-01c2c4b4ca-44
updated
0.1 tag added
0.1 tag added
0.1 tag added
we added the seed data as part of release kit
CORE Services LTS2.9
DIGIT 2.9 LTS
Mail Notification
egov-notification-mail:core-2.9-lts-mvn-check-c33cfe45ab-4
updated
This section provides a detailed and comprehensive view of the micro planning system's internal mechanics. The LLD focuses on providing API specifications, sequence diagrams and database schema. This section serves as a blueprint for developers and engineers to implement the system accurately.
The Microplanning system is designed to allow users to generate, validate, and approve micro plans across various geographic boundaries. The system's architecture includes services for handling population data, plan estimates, employee assignments and facility linkages. The system is scalable, secure, and optimised for local and national-level campaigns.
1
Development is completed for all the features that are part of the release.
Yes
Code was frozen by 04-DEC-2024.
2
Test cases are documented by the QA team, and reviewed by the product owners, and test results are updated in the test cases sheet.
Yes
Test Cases for Microplanning v0.1
All test cases are reviewed by the Product Owner and results have been updated in the sheet. QA sign-off is given accordingly.
3
The incremental demo of the features showcased during the sprint showcase and feedback is incorporated. If possible, list out the JIRA tickets for feedback.
Yes
Demo given on 13-NOV-2024 for Microplanning
4
UI/UX audit review by UX architect is completed along with feedback incorporation for any changes in UI/UX.
Yes
Nipun Arora
@ AndrewJones
UI/UX audit is done and review comments are incorporated.
5
Incremental demos to the product owners are completed as part of the sprint and feedbacks are incorporated.
Yes
Demo given on 28-OCT-2023 for Microplanning
6
QA sign-off is completed by the QA team and communicated to the product owners. All the tickets' QA sign-off status is updated in JIRA.
Yes
Test Cases for Microplanning v0.1
All test cases are reviewed by the Product Owner and QA sign-off is given accordingly.
7
UI, API technical documents are updated for the release along with the configuration documents.
Yes
UI documentation for Microplanning
Nipun Arora
8
UAT promotion and regression testing from the QA team is completed. QA team has shared the UAT regression test cases with the product owners.
Yes
Test Cases for Microplanning v0.1
All test cases are reviewed by the Product Owner.
9
API automation scripts are updated for new APIs or changes to any existing APIs for the release. API automation regression is completed on UAT, the automation test results are analysed, and necessary actions are taken to fix the failure cases. Publish the list of failure use cases with a reason for failure and the resolution taken to fix these failures for the release.
Yes
Automation script is reviewed by the Tech Lead.
10
The API backward compatibility testing is completed.
Yes
Tested on 20-NOV-2024.
11
The communication is shared with the product owners for the completion of UAT promotion and regression by the QA team. The product owners have to give a product sign-off within one week of this communication.
Yes
UAT sign-off was completed. Sign-off dates 04-DEC-2024 for Microplanning
12
The UAT product sign-off communication is received from the product owners along with the release notes and user guides (if applicable).
Yes
UAT sign-off was completed. Sign-off dates 04-DEC-2024 for Microplanning.
13
The GIT tags and releases are created for the code changes for the release.
Added a new git tag V0.1
14
Verify whether the release notes are updated.
15
Verify whether all UAT builds are updated along with the GIT tag details.
All the budils are added with release tag V0.1
16
Verify whether all MDMS, configs, InfraOps configs are updated.
17
Verify whether all docs will be published to http://health.digit.org by the Technical Writer as part of the release.
Link
18
Verify whether all test cases are up to date and updated along with necessary permissions to view the test cases sheet. The test cases sheet is verified by the Test Lead.
Test Cases for Microplanning v0.1
19
Verify whether the UAT credentials sheet is updated with the details of new users and roles, if any.
20
Verify whether all the localisation data was added in UAT, including Hindi, and updated in the release kits.
All localisations added as part of the release.
21
Verify whether the product release notes and user guides are updated and published.
22
The demo of the released features is done by the product team as part of the sprint/release showcase.
Demo Link
23
Technical and product workshops/demos are conducted by the engineering and product teams to the implementation team (Implementation handover).
Technical and product handover to impel conducted on 06-DEC-2024. Signoff on handover is given on 13-DEC-2024
24
Bug-bash tickets
Yes
All the microplan related bugs from Bugbash are tested and signed-off on 10-DEC-2024.
25
Architect sign-off and technical quality report.
Signed off on 02-DEC-2024.
26
Success metrics and product roadmap.
Link
27
Programme roll-out plan.
Link
28
Implementation checklist.
Impel checklist
29
Implementation roll-out plan.
Roll-out plan
30
Gate 2
31
The internal release communication along with all the release artefacts are shared by the engineering/product teams.
32
Plan for upgrading the staging/demo instance with the release product - within 2-4 weeks based on the period where no demos are planned from staging for the previous version of the released product.
33
The release communication to partners is shared by the GTM team and the webinar is arranged by the GTM team after the release communication - within 2-4 weeks of the release.
Plan Service
Plan Service Persister
Plan Service Indexer
Plan Chart API Config
Census Service
Census Service Persister
Census Service Indexer
Census Chart API Config
For MDMS-V2 changes, refer to the files below for MDMS schema and data that needs to be added for Microplanning:
For the addition of Indexer Mappings, refer to the file below and add the mappings for Microplanning:
For Workflow - Business Services, refer to the following and add business services for Plan Service and Census Service for Microplanning:
Changes are being tracked in the Excel sheet:
Health campaign microplanning is a detailed planning approach used to ensure that health interventions, such as immunisations or disease prevention campaigns, are effectively delivered to target populations.
Updated registry: Assume that the registry data required for microplanning is accurate and up-to-date. This includes boundary data for countries, provinces, districts, and villages, as well as the location of health facilities and other points of interest. The user can update the registry while setting up the microplan.
User Roles and Access: Assume that users will be assigned specific roles (e.g., system administrator, data collector, reviewer) with corresponding access levels and permissions to ensure data integrity and security.
Data Collection Methodology: Assume that data collection methods are standardized and that data collectors are trained to ensure the consistency and accuracy of the data entered into the system.
Connectivity: Assume that users will have access to the internet or a mobile network to use the platform, although there should be provisions for offline data collection and synchronization when connectivity is limited for certain use cases.
Localization: Assume that the platform will be localized to support multiple languages and adapt to the cultural and linguistic diversity of the target communities. For the first release, the platform will be localised for English, French, and Portuguese languages.
Scalability: Assume that the platform will be scalable to accommodate additional users, data, and campaigns without significant performance degradation.
User Training and Support: Assume that users will receive adequate training on how to use the platform and that support will be available to address any issues or questions that arise.
Sustainability: Assume that the platform will be designed with sustainability in mind, considering the long-term maintenance and updates required to keep the system operational and relevant.
No registry changes: Assume that no new boundary registry or facility registry will be created or updated once the microplan setup is completed.
Below are the users involved in the microplanning process -
a. System administrator - This user is responsible for setting up the microplanning platform such as selecting campaign boundaries, setting up the data, configuring the microplan assumptions, etc. This user will belong to the national/country-level administrative hierarchy.
b. Data collector - This user is responsible for collecting and validating the population data from every village assigned to him/her. He will also capture the geographical features of the assigned villages such as the accessibility level of the village, the security level of the village, etc.
c. Supervisors - This is a user role that can be defined for multiple users across different administrative hierarchies. Every supervisor will have its action mapping such as supervisors with only data approver access, supervisors with microplan approval access, etc. The different type of supervisors involved are
Population data approver - This user will have access to the microplan module to view, validate, and approve the population of the assigned boundaries. The approved population will be used for the estimation of resources of the microplan.
Facility catchment mapper - This user will have access to the microplan module to map the facilities to their catchment boundaries w.r.t the user’s assigned boundaries.
Microplan approver - This user will have access to the microplan module to view, edit, and approve the microplanning estimation concerning the user’s assigned boundaries.
Microplan viewer - This user will have access to the microplan module to only view the microplanning estimation concerning the user’s assigned boundaries.
The boundary registry is configured and updated during the instance creation for the country.
For defining the campaign facilities, the ‘Facility type’ should be configured in the MDMS during the instance creation for the country.
The facility or point of service capacity must be defined for the campaign type during instance creation. For the bednets campaign, the capacity should be ‘Bales’ ideally, for the SMC campaign, the capacity should be ‘Blisters’ ideally. It may change depending on the user’s requirements.
While managing the facility registry, the ‘Facility status’ needs to be configured in the MDMS during the instance creation of the country.
In the facility upload template, the column ‘Is fixed post?’ column options as ‘Yes’ or ‘No’ need to be configured in the MDMS
In the facility upload template, the column ‘Facility usage’ column options as ‘Active’ or ‘Inactive’ need to be configured in the MDMS
The capacity of the vehicle needs to be configured in the MDMS during instance setup. For the bednets campaign, the capacity should be ‘Bales’ ideally, for the SMC campaign, the capacity should be ‘Blisters’ ideally. It may change depending on the user’s requirements.
There will be 3 different registry data that will be used in this version of the microplan:
Boundary registry - The boundary registry is defined in the MDMS and the same registry can be used in the microplanning module. The boundary registry will later be created & managed by the admin console in the next version of the admin console.
Facility registry - The facility registry is defined in the MDMS and the same registry can be used in the microplanning module. The facility registry will later be created & managed by the admin console in the next version of the admin console.
Vehicle registry - The vehicle registry is defined in the MDMS and the same registry can be used in the microplanning module. The vehicle registry will later be created & managed by the admin console in the next version of the admin console.
Capturing campaign details -
Actor: System administrator/Program manager
Administrative boundary: National/Country
Using this screen, the user will be able to capture the campaign details for which the microplanning needs to be done. The components of this screen are -
a. Disease identified for the campaign - By default ‘Malaria’ will be chosen as we are creating the microplanning for the assumptions of malaria. As and when new diseases come into picture and we will have a better understanding of the assumptions and estimation, we will add those diseases in the dropdown.
b. Type of campaign - Upon choosing the disease, the user will be asked to choose the campaign type, which is either ‘Bednet’ or ‘SMC’. New campaign types can be included as and when understanding of the assumptions and estimation for them can be captured.
c. Resource distribution strategy - Upon choosing the campaign type, the user will be asked to choose the distribution strategy, which is either ‘Fixed post’ or ‘House-to-House’ or ‘Fixed post & House-to-House’. Depending on the strategy chosen, the assumptions and resource calculations will be configured by the platform.
d. Next - On click of ‘Next’, the campaign details will be saved and the user will be redirected to the next screen for naming the microplan.
e. Back - On click of ‘Back’, the user will be redirected to the homepage to either create a new microplan or to open a saved microplan.
Capture microplan name -
Actor: System administrator/Program manager
Administrative boundary: National/Country
Using this screen, the user can view the details of the campaign for which the microplanning needs to be done, and the user will be able to name the microplan accordingly for further use. The components of this screen are -
a. Campaign details - The campaign basic details chosen in the previous screen such as campaign disease, campaign type and resource distribution strategy will be shown here.
b. Naming of microplan - The microplan name will be auto suggested by the system. The structure of microplan name is ‘Country-Disease-CampaignType-MonthLast2digitsOfYear’. The name is a suggested name and the user can edit the microplan name if required. It’s a mandatory field.
Validation: The microplan name must be unique and can’t be the same as any previous created microplan name. If the user tries to enter a name that has been used already, show the error message ‘The name you have entered, has already been used. Please try a different name.’
c. Microplan naming format - This segment talks about the criteria for creating a microplan name, if the user wants to self create a microplan name. The naming convention are:
i. The name should be a minimum of 3 characters in length
ii. Only numeric values are not allowed
iii. Special characters -, _, (, ) are only allowed
Validation: If a user tries to enter a name that doesn’t match with the naming convention, show an error message ‘The name you have entered doesn’t match with the naming convention. Please try a different name.’
The max length of the microplan name is 100 characters.
d. Next - On click of ‘Next’, the microplan name will be saved and unedited. At this stage, the microplan will move to ‘Drafted setup’ status for being re-used or worked upon later.
e. Back - On click of ‘Back’, the user will be redirected to the previous step of capturing campaign details, but the microplan status will not change.
Selection of campaign boundary -
Actor: System administrator/Program manager
Administrative boundary: National/Country
This screen will be used for choosing the campaign boundary where the microplanning estimation needs to be done. The below administrative hierarchy is configured for Mozambique, and the same administrative hierarchies will be different for different countries. The administrative hierarchy is defined during the instance setup of a country. The components of this screen are -
a. Selected boundaries count label - There will be a label on top of the screen where user will be able to see count of boundaries chosen as:
# of country chosen
# of province chosen
# of district chosen
# of admin post chosen
# of locality chosen
# of the village chosen.
b. Country - Here the user will choose the country where the campaign needs to be executed. It’s a mandatory field.
c. Province - Here the user will choose the province where the campaign needs to be executed. There can be multiple provinces to choose from depending on the country chosen. It will be a multi-select search-enabled dropdown for the user to choose the province(s). It’s a mandatory field.
d. District - Here the user will choose the district(s) where the campaign needs to be executed. There can be multiple districts to choose from depending on the provinces chosen. It will be a multi-select search-enabled dropdown for the user to choose the district(s). It’s a mandatory field.
e. Administrative post - Here the user will choose the admin post(s) where the campaign needs to be executed. There can be multiple admin post(s) to choose from depending on the districts chosen. It will be a multi-select search-enabled dropdown for the user to choose the admin post(s). It’s a mandatory field.
f. Locality - Here the user will choose the locality(s) where the campaign needs to be executed. There can be multiple locality(s) to choose from depending on the admin posts chosen. It will be a multi-select search-enabled dropdown for the user to choose the locality(s). It’s a mandatory field.
g. Village - Here the user will choose the village(s) where the campaign needs to be executed. There can be multiple village(s) to choose from depending on the localities chosen. It will be a multi-select search-enabled dropdown for the user to choose the village(s). It’s a mandatory field.
h. Next - On click of ‘Next’, the campaign boundaries will be chosen for microplanning. The same set of boundaries will be further used for data upload in the next part. All the fields are mandatory for moving to the next screen.
i. Back - On click of ‘Back’, the user will be redirected to the previous screen for naming microplan.
Validation: Once the microplan name is chosen and the user moves to the next screen, the microplan name can’t be changed.
Users can view all the selected boundaries as an array of lists and clear the selected boundaries if required. The user will be able to see the list of chosen boundaries for the parent boundary in the content box. For example, if the user chooses to see the list of districts chosen, then it will show in the content box with the province name and the list of districts attached to the province, if there are multiple provinces, there will be multiple content boxes.
Data management process (Population upload) -
Actor: System administrator/Program manager
Administrative boundary: National/Country
This screen will be used for uploading the population data for the boundaries chosen for microplanning. When the user chooses the campaign boundaries in the previous step, the user in this step will have to upload the total and target population of the villages chosen in the campaign boundaries. The components of this screen are -
a. Download population template - This component will be used when the user has to download the boundary template to enter the population details for microplan estimation. The template will be separately downloaded & maintained for both bednets and SMC (As of now).
This screen will appear for the user to download the population template to be filled and upload
The user may skip it if he/she wants to move ahead without downloading the population template
The content of the downloadable bednet template is as follows -
Country: This shows the country where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Province: This shows the province(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
District: This shows the district(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Administrative post: This shows the admin post(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Locality: This shows the locality(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Village: This shows the village(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Total population: Here the user will be asked to enter the total village population.
Target population: Here the user will be asked to enter the target population who will be benefiting from the campaign.
Latitude & longitude: Here the user will be asked to enter the latitude & longitude of the village to be shown on the map.
For every campaign district, there will be a sheet in the downloadable report that the user needs to fill out and upload.
Note: The template should be configurable depending on the program. For Mozambique, the population template Excel has each sheet for the district. If the program wants to configure and collect data for each administrative post or locality level, the Excel sheets should be configured accordingly to collect population information in the administrative post or locality level.
Validation check:
The columns from ‘Country’ or highest administrative boundary to ‘Village’ or lowest administrative boundary should be fixed in the Excel and non-editable
The target population column is mandatory & can’t be empty
The total population column is mandatory & can’t be empty
The population data must only accept a whole number (Eg: 1234 and not 123.4)
The population data must be greater than 0
The Latitude & Longitude fields should have data in Degree Decimal and Degree Minute Seconds
The content of downloadable SMC template is as follows -
Country: This shows the country where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Province: This shows the province(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
District: This shows the district(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Administrative post: This shows the admin post(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Locality: This shows the locality(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Village: This shows the village(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Total population: Here the user will be asked to enter the total village population.
Target population (Age 3 - 11 months): Here the user will be asked to enter the target population count of the children between 3 - 11 months in the village.
Target population (Age 12 - 59 months): Here the user will be asked to enter the target population count of the children between 12 - 59 months in the village.
Latitude & longitude: Here the user will be asked to enter the latitude & longitude of the village to be shown on the map.
For every campaign district, there will be a sheet in the downloadable report that the user needs to fill out and upload.
Note: The template should be configurable depending on the program. For Mozambique, the population template Excel has each sheet for the district. If the program wants to configure and collect data for each administrative post or locality level, the Excel sheets should be configured accordingly to collect population information at the administrative post or locality level.
Validation check:
The columns from ‘Country’ or highest administrative boundary to ‘Village’ or lowest administrative boundary should be fixed in the Excel and non-editable
The target population columns (Age 3-11 months and age 12-59 months) are mandatory & can’t be empty
The total population column is mandatory & can’t be empty
The population data must only accept a whole number (Eg: 1234 and not 123.4)
The population data must be greater than 0
The Latitude & Longitude fields should have data in Degree Decimal and Degree Minute Seconds
b. Upload population template - This component will be used when the downloaded population excel file is filled and needs to be uploaded for estimating the campaign resource estimation.
The user can preview the uploaded file by clicking on the file name and it will open up the Excel preview
The user can re-upload the file using the ‘Re-upload’ button
The user can download the already uploaded file using the ‘Download’ button
The user can delete the uploaded file using the ‘X’ button, and once deleted, the user will be moved back to the Excel upload screen
The user will be able to view the number of errors captured in the uploaded file
The ‘View errors’ button will let the user view the list of errors in a tabular format
Error validation:
For bednet and SMC template upload - If the total population data uploaded is empty for any village, then show the error message ‘Total population data can’t be empty, please update the data and re-upload’.
For bednet and SMC template upload - If the total population data uploaded is not a whole number, then show the error message ‘Total population data must be a whole number, please update the data and re-upload’.
For bednet template upload - If the target population data uploaded is empty for any village, then show the error message ‘Target population data can’t be empty, please update the data and re-upload’.
For bednet template upload - If the target population data uploaded is not a whole number, then show the error message ‘Target population data must be a whole number, please update the data and re-upload’.
For SMC template upload - If the target population data (Age 3-11 months or Age 12-59 months) uploaded is empty for any village, then show the error message ‘Target population data can’t be empty, please update the data and re-upload’.
For SMC template upload - If the target population data (Age 3-11 months or Age 12-59 months) uploaded is not a whole number, then show the error message ‘Target population data must be a whole number, please update the data and re-upload’.
For bednet and SMC template upload - if the lat & long data uploaded does not adhere to the guideline, then show the error message ‘The latitude and longitude data does not comply with the guideline structure, please update the data and re-upload’.
The uploaded Excel file must have ‘Readme’ and ‘District sheets chosen in the boundary selection’, or the microplanning system will not validate and approve the file. Error message to be shown ‘One or more data sheets is absent, please update the data and re-upload the file’.
c. Error list view - This component will be shown when the upload file has one or more errors. The user can view the list of errors on the screen as well as download the errors as an Excel to view the error details in each row of Excel sheet.
The user will be able to navigate through the different errors using the ‘Previous’ or ‘Next’ buttons highlighted during data upload on the error view screen
All the errors will be highlighted in red color
On top of the preview screen, the user will be able to view the error details, for example, here the error mentioned that ‘Row 24 is empty!’
The user can download the Excel file with the detailed error mentioned. There should be an added column called ‘Error details’ that should show the errors in comma-separated format in case a single row has multiple errors
On click of ‘Back’ the user should be exited from the error preview screen
d. Excel upload guideline - The guideline directs the user on what to keep in mind while entering the population data and uploading it for the microplanning estimation. The guidelines are below for population data upload -
The mandatory fields such as total population and target population data must be a whole number (For example, population can be 1234 and not 123.5)
The Latitude & Longitude fields should have data in Degree Decimal and Degree Minute Seconds ( Value should be 12.3455 & not 12° 20' 43.7994")
e. Data management process (Facility upload) -
Actor: System administrator/Program manager
Administrative boundary: National/Country
This screen will be used to set up the facilities that are required for the campaign execution and microplanning estimation. Every facility to be used in the campaign needs to be added using this screen. The competent of this screen are -
a. Download facility template - This component will be used when the user needs to see the list of facilities available for the instance. The user can download the facility template and check out the facility list accordingly for campaign execution.
This screen will appear for the user to download the facility template to be updated and upload
The user may skip it if he/she wants to move ahead without downloading the facility template
The facility template will have 2 different Excel sheets:
Facility sheet content:
Facility Name: If the instance already has facilities defined, then the user will be able to see the name of the facilities that are existing.
Facility Type: If the instance already has facilities defined, then the user will be able to see the type of facilities that are linked to each facility. The facility type for an instance will be defined in the MDMS during instance creation. This will be a dropdown option.
Facility Status: If the instance already has facilities defined, then the user will be able to see the status of the facilities that are existing. The facility status for an instance will be defined in the MDMS during instance creation. This will be a dropdown option.
Capacity: If the instance already has facilities defined, then the user will be able to see the capacity of the facilities that are existing. The definition of capacity of the facility is defined in the MDMS during instance creation.
Facility usage: If the instance already has facilities defined, then the user will be able to see the usage status of the facilities that are existing. ‘Active’ usage status means the facility is operational for the campaign and ‘Inactive’ usage status means the facility is non-operational for the campaign. The usage status is defined in the MDMS during instance creation. This will be a dropdown option.
Is fixed post?: If the instance already has facilities defined, then the user will be able to see if the facilities will be catered as a fixed post. The fixed post tag will only be functional when the resource distribution strategy is either Fixed post or House-to-House & Fixed post (Both). For instance, the fixed post tag will be defined for a facility unless it is manually changed by the user. This will be a dropdown option.
Residing boundary code: The residing boundary code defines where (Which village) exactly the facility resides. The user will be able to tag the boundary where the facility resides using the residing boundary sheet. The residing boundary of the facilities will be saved for the instance and it can be changed as per the user’s requirement during the facility configuration. This will be a dropdown option.
Latitude & Longitude: Here the user will be asked to enter the latitude & longitude of the village to be shown on the map.
Residing boundary sheet content:
Country: This shows the country where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Province: This shows the province(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
District: This shows the district(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Administrative post: This shows the admin post(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Locality: This shows the locality(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Village: This shows the village(s) where the campaign needs to run. This will be pre-defined in the downloaded template as per boundary selection in the previous step.
Boundary code: This shows the boundary code of the village where the campaign needs to run. The boundary code will be pre-defined for every village during the boundary registry configuration at the instance creation.
b. Upload facility template - This component will be used to upload the facility template to configure the facilities to be used in the campaign. The user can fill the template with the required details and upload the file accordingly. The user can add a new facility as well as deactivate the existing facilities to be used in the campaign.
The user can preview the uploaded file by clicking on the file name and it will open up the excel preview
The user can re-upload the file using the ‘Re-upload’ button
The user can download the already uploaded file using the ‘Download’ button
The user can delete the uploaded file using the ‘X’ button, and once deleted, the user will be moved back to the Excel upload screen
The user will be able to view the number of errors captured in the uploaded file
The ‘View errors’ button will let the user view the list of errors in a tabular format
Error validation:
In the facility sheet, the ‘Facility Name’ is a mandatory field. The user needs to enter the facility name before uploading the file into the system. Error message when there is no facility name defined ‘The facility name doesn’t exist in the uploaded file, please update and re-upload’.
In the facility sheet, the ‘Facility Type is a mandatory field. The user needs to enter the facility type before uploading the file into the system. Error message when there is no facility type defined ‘The facility type doesn’t exist for the facility in the uploaded file, please update and re-upload’.
In the facility sheet, the ‘Facility Status’ is a mandatory field. The user needs to enter the facility status before uploading the file into the system. Error message when there is no facility status defined ‘The facility status doesn’t exist for the facility in the uploaded file, please update and re-upload’.
In the facility sheet, the ‘Capacity’ is a mandatory field. The user needs to enter the facility capacity before uploading the file into the system. The unit of facility capacity needs to be defined in the MDMS during instance creation. Error message when there is no facility capacity defined ‘The facility capacity doesn’t exist for the facility in the uploaded file, please update and re-upload’.
In the facility sheet, the ‘Facility usage’ is a mandatory field. The user needs to enter the facility usage before uploading the file into the system. Error message when there is no facility usage defined ‘The facility usage information doesn’t exist for the facility in the uploaded file, please update and re-upload’.
In the facility sheet, the ‘Is fixed post?’ is a mandatory field. The user needs to enter the facility-fixed post tag before uploading the file into the system. Error message when there is no fixed post tag defined ‘The facility doesn’t have a fixed post tag defined in the uploaded file, please update and re-upload’.
Validation: This validation will be available only when the resource distribution strategy is either Fixed post or Fixed post & H2H.
In the facility sheet, the ‘Residing boundary code’ is a mandatory field. The user needs to enter the facility’s residing boundary code before uploading the file into the system. Error message when there is no facility’s residing boundary code defined ‘The facility’ residing boundary code doesn’t exist for the facility in the uploaded file, please update and re-upload’.
If the lat & long data uploaded do not adhere to the guideline, then show the error message ‘The latitude and longitude data does not comply with the guideline structure, please update the data and re-upload’.
The uploaded Excel file must have ‘Readme’, ‘Facility’, and ‘Residing boundary’ sheets. The residing boundary sheet will have boundaries chosen for the campaign, else the file will not be validated and approved by the microplanning system. Error message to be shown ‘One or more data sheets are absent in the uploaded file, please update the data and re-upload the file’.
c. Error list view - This component will be shown when the upload file has one or more errors. The user can view the list of errors on the screen as well as download the errors as an Excel to view the error details in each row of the Excel sheet.
The user will be able to navigate through the different errors using the ‘Previous’ or ‘Next’ buttons highlighted during data upload on the error view screen
All the errors will be highlighted in red color
On top of the preview screen, the user will be able to view the error details, for example, here the error mentioned that ‘Row 24 is empty!’
The user will be able to download the Excel file with the detailed error mentioned. There should be an added column called ‘Error details’ that should show the errors in comma-separated format in case a single row has multiple errors
On click of ‘Back’ the user should be exited from the error preview screen
d. Excel upload guideline - The guideline directs the user on what to keep in mind while entering the facility data and uploading it for the microplanning estimation. The guidelines are below for population data upload -
All the fields are mandatory and can't be empty, except the Latitude and Longitude fields
The Latitude & Longitude fields should have data in Degree Decimal and Degree Minute Seconds ( Value should be 12.3455 & not 12° 20' 43.7994")
Data management process (Vehicle management) -
Actor: System administrator/Program manager
Administrative boundary: National/Country
This screen will be used to set up the vehicles that are required for the campaign execution and microplanning estimation. Every vehicle to be used in the campaign needs to be added or chosen using this screen. The competent of this screen are -
a. Choosing vehicle type - The user will be asked to select the vehicle type to show the list of vehicles that belong to the vehicle type. Choosing of vehicle type is a multi-select dropdown and upon showing the vehicle list for the chosen vehicle type, the user can choose different vehicles that will be used for campaign execution. The user can choose multiple vehicles at a time.
Validation: It is mandatory to choose at least 1 vehicle for the campaign
b. Showing vehicle details - Once the vehicle lists is shown to the user, the user can check-out the vehicle details and then choose which vehicles to be used for the campaign. The basic vehicle details that will be shown to the users per vehicle are:
Vehicle type
Manufacture
Model
Vehicle capacity - ‘Bales’ for bednets/ ‘Blisters’ for SMC
c. Adding new vehicle details - If the user doesn’t find the vehicle details, he will be asked to add new vehicle details for the campaign. All the fields are mandatory here for adding a new vehicle.
The fields that the user can configure while adding new vehicle information are -
a. Vehicle type - If there is no vehicle type registered for the instance, then the user will get only one option to choose ‘Others’ to add the vehicle type.
b. Enter vehicle type - If the vehicle type is chosen as ‘Others’, the user will be asked to enter the vehicle type. It’s a mandatory field.
c. Enter vehicle manufacturer - The user will be asked to enter the vehicle manufacturer details. It’s a mandatory field.
d. Enter vehicle model - The user will be asked to enter the vehicle model details here. It’s a mandatory field.
e. Enter vehicle capacity (Bales/Blisters) - The vehicle capacity will be defined as ‘Bales’ for bednets and ‘Blisters’ for SPAQ/SMC. It’s a mandatory field.
Validation: The capacity input value must be numerical. Error message if the capacity is invalid ‘The value must be numerical’.
f. Submit - Once the vehicle details are entered here, the user will be directed to submit the details and the vehicle details will be saved in the MDMS for the instance.
Microplan hypothesis and formula configuration -
Actor: System administrator/Program manager
Administrative boundary: National/Country
Case A: When the resource distribution strategy is ‘House-to-House’ and the campaign type is either ‘Bednets’ or ‘SMC’
Sub-Case 1:
Figma sample for choosing preliminary questions (Resource distribution strategy = House-to-House):
Q1. How is the campaign registration process happening?
The user will have only one option to choose from the dropdown ‘House-to-House’
Q2. How is the campaign distribution process happening?
The user will have only one option to choose from the dropdown ‘House-to-House’
Q3. Is the registration and distribution process happening together or separately?
The user will have one of the two options to choose from the dropdown either ‘Together’ or ‘Separately’. Here, the user will choose ‘Together’.
Figma sample for assumption config 1 (Bednets):
Figma sample for assumption config 2 (Bednets):
Figma sample for assumption config 3 (Bednets):
Figma sample for assumption config 4 (Bednets):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
Figma sample for assumption config 1 (SMC):
Figma sample for assumption config 2 (SMC):
Figma sample for assumption config 3 (SMC):
Figma sample for assumption config 4 (SMC):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
In the above images, all the microplan hypotheses are pre-configured in the MDMS.
The user can add new microplan assumptions or delete an old assumption according to the campaign needs. All the microplan assumptions are configured for the village or lowest boundary level.
Upon adding a new microplan assumption, the user will be asked to enter the assumption and attach a value to it. The same assumption will be used in the microplan resource estimation formula.
If an assumption is deleted, upon adding a new assumption the user will be asked choose to either the deleted assumption or create a new assumption.
Depending on the microplan hypothesis configured, the user will be able to check-out the resource estimation formula and then make changes in the formula configuration accordingly.
Figma sample for formula config 1 (Bednets):
Figma sample for formula config 2 (Bednets):
Figma sample for formula config 3 (Bednets):
Figma sample for formula config 4 (Bednets):
Figma sample for formula config 1 (SMC):
Figma sample for formula config 2 (SMC):
Figma sample for formula config 3 (SMC):
Figma sample for formula config 4 (SMC):
In the above images, all the microplan resource estimation formulas are pre-configured in the MDMS.
The user can add a new estimation formula or delete an old formula according to the campaign needs. All the microplan estimation formulas are configured on the village or lowest boundary level. All the values shown will be auto reflected in the microplan estimation dashboard, unless the user wants to disable the ‘Show on estimation dashboard’ checkbox.
If a pre-defined formula is deleted, upon adding a new formula, the user should get an option either to add the deleted formula or add a completely new formula.
Upon adding a completely new estimation formula, the user will be asked to -
Enter the parameter of the resource estimation
Formula inputs
Operator (*,-,+,/)
Eg: Number of bednets (Resource estimation parameter) = Target population (Input) / Number of people per bednet (Input)
Sub-Case 2:
Figma sample for choosing preliminary questions (Resource distribution strategy = House-to-House):
Q1. How is the campaign registration process happening?
The user will have only one option to choose from the dropdown ‘House-to-House’
Q2. How is the campaign distribution process happening?
The user will have only one option to choose from the dropdown ‘House-to-House’
Q3. Is the registration and distribution process happening together or separately?
The user will have one of the two options to choose from the dropdown either ‘Together’ or ‘Separately’. Here, the user will choose ‘Separately’.
Figma sample for assumption config 1 (Bednets):
Figma sample for assumption config 2 (Bednets):
Figma sample for assumption config 3 (Bednets):
Figma sample for assumption config 4 (Bednets):
Figma sample for assumption config 5 (Bednets):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
Figma sample for assumption config 1 (SMC):
Figma sample for assumption config 2 (SMC):
Figma sample for assumption config 3 (SMC):
Figma sample for assumption config 4 (SMC):
Figma sample for assumption config 5 (SMC):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
In the above images, all the microplan hypotheses are pre-configured in the MDMS.
The user can add new microplan assumptions or delete an old assumption according to the campaign needs. All the microplan assumptions are configured on the village or lowest boundary level.
Upon adding a new microplan assumption, the user will be asked to enter the assumption and attach a value to it. The same assumption will be used in the microplan resource estimation formula. If an assumption is deleted, upon adding a new assumption the user will be asked to choose to either the deleted assumption or create a new assumption.
Depending on the microplan hypothesis configured, the user will be able to check-out the resource estimation formula and then make changes in the formula configuration accordingly.
Figma sample for formula config 1 (Bednets):
Figma sample for formula config 2 (Bednets):
Figma sample for formula config 3 (Bednets):
Figma sample for formula config 4 (Bednets):
Figma sample for formula config 5 (Bednets):
Figma sample for formula config 1 (SMC):
Figma sample for formula config 2 (SMC):
Figma sample for formula config 3 (SMC):
Figma sample for formula config 4 (SMC):
Figma sample for formula config 5 (SMC):
In the above images, all the microplan resource estimation formulas are pre-configured in the MDMS.
The user can add a new estimation formula or delete an old formula according to the campaign's needs. All the microplan estimation formulas are configured on the village or lowest boundary level. All the values shown will be auto-reflected in the microplan estimation dashboard unless the user wants to disable the "Show on estimation dashboard" checkbox.
If a pre-defined formula is deleted, upon adding a new formula, the user should get an option either to add the deleted formula or add a completely new formula.
Upon adding a new estimation formula, the user will be asked to -
Enter the parameter of the resource estimation
Formula inputs
Operator (*,-,+,/)
Example: Number of bednets (Resource estimation parameter) = Target population (Input) / Number of people per bednet (Input)
Case B: When the resource distribution strategy is ‘Fixed post’ and the campaign type is either ‘Bednets’ or ‘SMC’
Sub-case 1:
Figma sample for choosing preliminary questions (Resource distribution strategy = Fixed post):
Q1. How is the campaign registration process happening?
The user will have only one option to choose from the dropdown ‘Fixed post’
Q2. How is the campaign distribution process happening?
The user will have only one option to choose from the dropdown ‘Fixed post’
Q3. Is the registration and distribution process happening together or separately?
The user will have one of the two options to choose from the dropdown either ‘Together’ or ‘Separately’. Here, the user will choose ‘Together’.
Figma sample for assumption config 1 (Bednets):
Figma sample for assumption config 2 (Bednets):
Figma sample for assumption config 3 (Bednets):
Figma sample for assumption config 4 (Bednets):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
Figma sample for assumption config 1 (SMC):
Figma sample for assumption config 2 (SMC):
Figma sample for assumption config 3 (SMC):
Figma sample for assumption config 4 (SMC):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
In the above images, all the microplan hypotheses are pre-configured in the MDMS.
The user can add new microplan assumptions or delete an old assumption according to the campaign needs. All the microplan assumptions are configured on the village or lowest boundary level.
Upon adding a new microplan assumption, the user will be asked to enter the assumption and attach a value to it. The same assumption will be used in the microplan resource estimation formula.
If an assumption is deleted, upon adding a new assumption the user will be asked to choose to either delete the assumption or create a new assumption.
Depending on the microplan hypothesis configured, the user will be able to check the resource estimation formula and then make changes in the formula configuration accordingly.
Figma sample for formula config 1 (Bednets):
Figma sample for formula config 2 (Bednets):
Figma sample for formula config 3 (Bednets):
Figma sample for formula config 4 (Bednets):
Figma sample for formula config 1 (SMC):
Figma sample for formula config 2 (SMC):
Figma sample for formula config 3 (SMC):
Figma sample for formula config 4 (SMC):
In the above images, all the microplan resource estimation formula are pre-configured in the MDMS.
The user can add a new estimation formula or delete an old formula according to the campaign's needs. All the microplan estimation formulas are configured on the village or lowest boundary level. All the values shown will be auto-reflected in the microplan estimation dashboard unless the user wants to disable the "Show on estimation dashboard" checkbox.
If a pre-defined formula is deleted, upon adding a new formula, the user should get an option either to add the deleted formula or add a completely new formula.
Upon adding a new estimation formula, the user will be asked to -
Enter the parameter of the resource estimation
Formula inputs
Operator (*,-,+,/)
Example: Number of bednets (Resource estimation parameter) = Target population (Input) / Number of people per bednet (Input)
Sub-case 2:
Figma sample for choosing preliminary questions (Resource distribution strategy = Fixed post):
Q1. How is the campaign registration process happening?
The user will have only one option to choose from the dropdown ‘Fixed post’
Q2. How is the campaign distribution process happening?
The user will have only one option to choose from the dropdown ‘Fixed post’
Q3. Is the registration and distribution process happening together or separately?
The user will have one of the two options to choose from the dropdown either ‘Together’ or ‘Separately’. Here, the user will choose ‘Separately’.
Figma sample for assumption config 1 (Bednet):
Figma sample for assumption config 2 (Bednet):
Figma sample for assumption config 3 (Bednet):
Figma sample for assumption config 4 (Bednet):
Figma sample for assumption config 5 (Bednet):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
Figma sample for assumption config 1 (SMC):
Figma sample for assumption config 2 (SMC):
Figma sample for assumption config 3 (SMC):
Figma sample for assumption config 4 (SMC):
Figma sample for assumption config 5 (SMC):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
In the above images, all the microplan hypotheses are pre-configured in the MDMS.
The user can add new microplan assumptions or delete an old assumption according to the campaign needs. All the microplan assumptions are configured on the village or lowest boundary level.
Upon adding a new microplan assumption, the user will be asked to enter the assumption and attach a value to it. The same assumption will be used in the microplan resource estimation formula.
If an assumption is deleted, upon adding a new assumption the user will be asked to choose to either the deleted assumption or create a new assumption.
Depending on the microplan hypothesis configured, the user will be able to check the resource estimation formula and then make changes in the formula configuration accordingly.
Figma sample for formula config 1 (Bednets):
Figma sample for formula config 2 (Bednets):
Figma sample for formula config 3 (Bednets):
Figma sample for formula config 4 (Bednets):
Figma sample for formula config 5 (Bednets):
Figma sample for formula config 1 (SMC):
Figma sample for formula config 2 (SMC):
Figma sample for formula config 3 (SMC):
Figma sample for formula config 4 (SMC):
Figma sample for formula config 5 (SMC):
In the above images, all the microplan resource estimation formulas are pre-configured in the MDMS.
The user can add a new estimation formula or delete an old formula according to the campaign's needs. All the microplan estimation formulas are configured on the village or lowest boundary level. All the values shown will be auto-reflected in the microplan estimation dashboard unless the user wants to disable the "Show on estimation dashboard" checkbox.
If a pre-defined formula is deleted, upon adding a new formula, the user should get an option either to add the deleted formula or add a completely new formula.
Upon adding a new estimation formula, the user will be asked to -
Enter the parameters of the resource estimation
Formula inputs
Operator (*,-,+,/)
Example: Number of bednets (Resource estimation parameter) = Target population (Input) / Number of people per bednet (Input)
Case C: When the resource distribution strategy is ‘Fixed post & House-to-House’ and the campaign type is either ‘Bednets’ or ‘SMC’
Figma sample for choosing preliminary questions (Resource distribution strategy = House-to-House & Fixed post):
Q1. How is the campaign registration process happening?
The user can choose either ‘Fixed post’ or ‘House-to-House’ or both
Q2. How is the campaign distribution process happening?
The user can choose either ‘Fixed post’ or ‘House-to-House’ or both
Depending on the registration and distribution process chosen, the microplan assumption will be shown to the user for configuration.
Figma sample for assumption config 1 (Bednets):
Figma sample for assumption config 2 (Bednets):
Figma sample for assumption config 3 (Bednets):
Figma sample for assumption config 4 (Bednets):
Figma sample for assumption config 5 (Bednets):
Figma sample for assumption config 6 (Bednets):
Figma sample for assumption config 7 (Bednets):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
Figma sample for assumption config 1 (SMC):
Figma sample for assumption config 2 (SMC):
Figma sample for assumption config 3 (SMC):
Figma sample for assumption config 4 (SMC):
Figma sample for assumption config 5 (SMC):
Figma sample for assumption config 6 (SMC):
Figma sample for assumption config 7 (SMC):
Validation: The input value of an assumption must be numerical and mandatory
Error message in case of invalid input “Please enter a numeric value”
In the above images, all the microplan hypotheses are pre-configured in the MDMS.
The user can add new microplan assumptions or delete an old assumption according to the campaign needs. All the microplan assumptions are configured on the village or lowest boundary level.
Upon adding a new microplan assumption, the user will be asked to enter the assumption and attach a value to it. The same assumption will be used in the microplan resource estimation formula.
If an assumption is deleted, upon adding a new assumption the user will be asked choose to either the deleted assumption or create a new assumption.
Depending on the microplan hypothesis configured, the user will be able to check the resource estimation formula and then make changes in the formula configuration accordingly.
In the above images, all the microplan resource estimation formulas are pre-configured in the MDMS.
The user can add a new estimation formula or delete an old formula according to the campaign's needs. All the microplan estimation formulas are configured on the village or lowest boundary level. All the values shown will be auto-reflected in the microplan estimation dashboard unless the user wants to disable the ‘Show on estimation dashboard’ checkbox.
If a pre-defined formula is deleted, upon adding a new formula, the user should get an option either to add the deleted formula or add a completely new formula.
Upon adding a new estimation formula, the user will be asked to -
Enter the parameter of the resource estimation
Formula inputs
Operator (+,-,*,/)
Example: Number of bednets (Resource estimation parameter) = Target population (Input 1) / Number of people per bednet (Input 2)
Manage data validation -
Actor: System administrator/Program manager
Administrative boundary: National/Country
This screen will be used to set up the data validation rule to highlight the population data discrepancies submitted by the ‘Data collector’ from the ground.
This process will help specifically in identifying if the population data collected and validated by the data collector for certain villages is correct or not. For example, the central team called out that a village has a total population of 2,000. However, while validating the data, the data collector at the village level mentioned that the total population of the village is 5000, which is more than 100% of what was earlier uploaded by the central team. With such cases, it becomes important for the data approver to have a second look at the data and make necessary adjustments in the village population data that can be used for microplan resource estimation.
The content of this screen are -
a. Minimum population of a village in Mozambique: In this field, the user needs to enter the minimum possible population of a village within the campaign region. This ensures that if the ‘Data collector’ validates and collects the total and target population for a village, which is less than the minimum village population configured, it should right away be highlighted to the assigned ‘Population data approver’ role. Here, the country name can be different for different countries, so it has to be configurable depending on the instance created for the country.
Validation: The field must accept a whole number value. Throw the error “Please enter a whole number” if an invalid value is entered.
b. The maximum population of a village in Mozambique: In this field, the user needs to enter the maximum possible population of a village within the campaign region. This ensures that if the ‘Data collector’ validates and collects the total and target population for a village, which is more than the maximum village population configured, it should right away be highlighted to the assigned ‘Population data approver’ role. Here, the country name can be different for different countries, so it has to be configurable depending on the instance created for the country.
Validation: The field must accept a whole number value. Throw the error “Please enter a whole number” if an invalid value is entered.
c. Acceptable change percentage (%) concerning population data uploaded for the villages: In this field, the user needs to enter the acceptable buffer % w.r.t to which the system will not highlight the data discrepancies. For example, if the acceptable change percentage is 10%, and the central team uploaded the total village population of Village-1 as 1000, then the acceptable population range is between 900 to 1100. So, if the ‘Data collector’ validates and collects the village-1 population as 1050, the system will not highlight the data discrepancies to the ‘Population data approver’ user, but if the ‘Data collector’ validates and collects the village-1 population as 1200, the system will highlight the data discrepancies to the ‘Population data approver’ user.
Validation: The field must accept a numeric value. Throw error “Please enter a numeric value” if invalid value entered.
d. Next: The user can move to the next screen to configure the role-action mapping
e. Back: The user can choose to go back to the previous screen of the estimation formula configuration by clicking ‘Back’
Note: The data validation rule configuration isn’t mandatory and the user can move to the next screen without configuration by clicking the ‘Next’ button
Configure access control -
Actor: System administrator/Program manager
Administrative boundary: National/Country
Role configuration - National microplan approver
This role will have access to edit microplan assumptions and approve and finalise microplan estimation for the country.
This screen will be used to configure the ‘National Microplan Estimation Approver’ user role. The assigned user will be able to validate and approve the population data from each village uploaded by the system administrator. The user will only be able to act on the population data of the villages that are assigned to his administrative boundary, i.e., country.
During the configuration of the microplan, there will be no users belonging to the ‘National microplan estimation approver’ role assigned to the ongoing microplan at first. The system administrator will have to click on the button ‘Assign National Microplan Estimation Approvers’ to start assigning the required users to the ongoing microplan.
Once the system administrator clicks on the ‘Assign National Microplan Estimation Approvers’ button, he/she will be prompted a pop-up to assign the users with ‘National Microplan Estimation Approver’ role to the ongoing microplan.
Here, the system admin will be able to assign/deassign a user to the ongoing microplan. The content of the pop-up are -
Search filters - The system admin can search a user using the ‘User’s name’ and ‘User’s contact number’.
Validation: Partial string search should be allowed
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be auto chosen as ‘Country’ as this user role belongs to the national level. The system administrator shouldn’t get any other administrative hierarchies to choose from.
Administrative area - This will be automatically chosen as the country where the microplan is being configured. The system administrator shouldn’t get any other administrative area to choose from.
Action - This capability will let the system administrator to assign/deassign users of the chosen role to the ongoing microplan. The system administrator can add at least one or more ‘National microplan estimation approver’ users to the ongoing microplan.
This pop-up shows the actions that the user can take. The ‘Assign’ button should only be enabled if the system administrator has chosen the administrative hierarchy and the administrative area for a particular user belonging to the role chosen.
Once the system administrator has assigned all the required users to the microplan, the list of assigned users and their details will be displayed on the screen. Content of the screen are -
Search assigned users - The system admin will be able to search a user using the ‘User’s name’.
Validation: Partial string search should be allowed
Assign users - This action will let the system administrator to assign/deassign users to the microplan.
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be fetched from the user data that will be used while assigning the user to the microplan.
Administrative area - This will be fetched from the user data that will be used while assigning the user to the microplan.
Once all the required users are added to the microplan, the system administrator will click on the ‘Save And Proceed’ button to go to the next role assignment screen.
Note: It’s mandatory to assign at least 1 ‘National microplan estimation approver’ user to the microplan.
Role configuration - National facility catchment assigner
This role will have access to assign & finalize the facility to the catchment areas of the assigned administrative boundary.
This screen will be used to configure the ‘National facility catchment assigner’ user role. The assigned facility catchment assigner will be allowed to map the campaign facilities or point of services to the catchment areas and to finalize the facility-to-catchment area mapping (Eg: Villages) of the assigned boundaries.
During the configuration of the microplan, there will be no users belonging to the ‘National facility catchment assigner’ role assigned to the ongoing microplan at first. The system administrator will have to click on the button ‘Assign National Facility Catchment Assigner’ to start assigning the required users to the ongoing microplan.
Once the system administrator clicks on the ‘Assign National Facility Catchment Assigner’ button, he/she will be prompted a pop-up to assign the users with the ‘National Facility Catchment Assigner’ role to the ongoing microplan.
Here, the system admin will be able to assign/deassign a user to the ongoing microplan. The content of the pop-up are -
Search filters - The system admin can search a user using the ‘User’s name’ and ‘User’s contact number’.
Validation: Partial string search should be allowed
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be auto chosen as ‘Country’ as this user role belongs to the national level. The system administrator shouldn’t get any other administrative hierarchies to choose from.
Administrative area - This will be automatically chosen as the country where the microplan is being configured. The system administrator shouldn’t get any other administrative area to choose from.
Action - This capability will let the system administrator assign/deassign users of the chosen role to the ongoing microplan. The system administrator can add at least one or more ‘National facility catchment assigner’ users to the ongoing microplan.
This pop-up shows the actions that the user can take. The ‘Assign’ button should only be enabled if the system administrator has chosen the administrative hierarchy and the administrative area for a particular user belonging to the role chosen.
Once the system administrator has assigned all the required users to the microplan, the list of assigned users and their details will be displayed on the screen. The content of the screen are -
Search assigned users - The system admin can search a user using the ‘User’s name’.
Validation: Partial string search should be allowed
Assign users - This action will let the system administrator assign/deassign users to the microplan.
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be fetched from the user data that will be used while assigning the user to the microplan.
Administrative area - This will be fetched from the user data that will be used while assigning the user to the microplan.
Once all the required users are added to the microplan, the system administrator will click on the ‘Save And Proceed’ button to go to the next role assignment screen.
Note: It’s mandatory to assign at least 1 ‘National facility catchment assigner’ user to the microplan.
Role configuration - National population data approver
This role will have access to validate, approve, and finalise the population data for the villages of the assigned administrative boundary.
This screen will be used to configure the ‘National population data approver’ user role. The assigned user will be able to validate, update, and approve the population data of each village uploaded by the system administrator. The user will only be able to act on the population data of the villages that are assigned to his administrative boundary.
During the configuration of the microplan, there will be no users belonging to the ‘National population data approver’ role assigned to the ongoing microplan at first. The system administrator will have to click on the button ‘Assign National Population Data Approver’ to start assigning the required users to the ongoing microplan.
Once the system administrator clicks on the ‘Assign National Population Data Approver’ button, he/she will be prompted a pop-up to assign the users with the ‘National Population Data Approver’ role to the ongoing microplan.
Here, the system admin will be able to assign/deassign a user to the ongoing microplan. The content of the pop-up are -
Search filters - The system admin can search a user using the ‘User’s name’ and ‘User’s contact number’.
Validation: Partial string search should be allowed
Name of the user - This will be fetched from the user management module for the chosen role.
The contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be auto-chosen as ‘Country’ as this user role belongs to the national level. The system administrator shouldn’t get any other administrative hierarchies to choose from.
Administrative area - This will be automatically chosen as the country where the microplan is being configured. The system administrator shouldn’t get any other administrative area to choose from.
Action - This capability will let the system administrator assign/deassign users of the chosen role to the ongoing microplan. The system administrator can add at least one or more ‘National population data approver’ users to the ongoing microplan.\
This pop-up shows the actions that the user can take. The ‘Assign’ button should only be enabled if the system administrator has chosen the administrative hierarchy and the administrative area for a particular user belonging to the role chosen.
Once the system administrator has assigned all the required users to the microplan, the list of assigned users and their details will be displayed on the screen. The content of the screen are -
Search assigned users - The system admin can search a user using the ‘User’s name’.
Validation: Partial string search should be allowed
Assign users - This action will let the system administrator assign/deassign users to the microplan.
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be fetched from the user data that will be used while assigning the user to the microplan.
Administrative area - This will be fetched from the user data that will be used while assigning the user to the microplan.
Once all the required users are added to the microplan, the system administrator will click on the ‘Save And Proceed’ button to go to the next role assignment screen.
Note: It’s mandatory to assign at least 1 ‘National population data approver’ user to the microplan.
Role configuration - Microplan estimation approver
This role will have access to edit microplan assumptions and approve microplan estimation of assigned administrative boundaries.
This screen will be used to configure the ‘Microplan estimation approver’ user role. The assigned Microplan estimation approver will be allowed to edit the microplan hypothesis, and validate and approve the microplan for the assigned administrative boundaries.
During the configuration of the microplan, there will be no users belonging to the ‘Microplan estimation approver’ role assigned to the ongoing microplan at first. The system administrator will have to click on the button ‘Assign Microplan Estimation Approvers’ to start assigning the required users to the ongoing microplan.
Once the system administrator clicks on the ‘Assign Microplan Estimation Approvers’ button, he/she will be prompted a pop-up to assign the users with ‘Microplan Estimation Approvers’ role to the ongoing microplan.
Here, the system admin will be able to assign/deassign a user to the ongoing microplan. The content of the pop-up are -
Search filters - The system admin can search a user using the ‘User’s name’ and ‘User’s contact number’.
Validation: Partial string search should be allowed
Name of the user - This will be fetched from the user management module for the chosen role.
The contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - The system administrator will be able to choose the administrative hierarchy from the dropdown. The system admin can choose one administrative hierarchy at a time. The system admin can’t choose the highest administrative hierarchy (Eg: Country) and the lowest administrative hierarchy (Eg: Village/Settlement) from the dropdown.
Administrative area - Upon choosing the administrative hierarchy, the system administrator will be able to choose the administrative areas for the chosen administrative hierarchy. The system administrator will be able to choose one or multiple administrative areas at a time. The list of administrative areas should be shown along with their respective parent boundaries.
Action - This capability will let the system administrator assign/deassign users of the chosen role to the ongoing microplan.
This pop-up shows the actions that the user can take. The ‘Assign’ button should only be enabled if the system administrator has chosen the administrative hierarchy and the administrative area for a particular user in the selected role.
Once the system administrator has assigned all the required users to the microplan, the list of assigned users and their details will be displayed on the screen. The content of the screen are -
Search assigned users - The system admin can search a user using the ‘User’s name’.
Validation: Partial string search should be allowed
Assign users - This action will let the system administrator assign/deassign users to the microplan.
Name of the user - This will be fetched from the user management module for the chosen role.
The contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be fetched from the user data that will be used while assigning the user to the microplan.
Administrative area - This will be fetched from the user data that will be used while assigning the user to the microplan.
Once all the required users are added to the microplan, the system administrator will click on the ‘Save And Proceed’ button to go to the next role assignment screen.
Validations for the ‘Microplan estimation approver’ role:
(Validation criteria for warning messages (Microplan estimation approver)
Role configuration - Microplan estimation viewer
This role will have access to view microplan estimations of assigned administrative boundaries.
This screen will be used to configure the ‘Microplan estimation viewer’ user role. The assigned microplan estimation viewer will be allowed to view the microplan estimation for the assigned administrative boundaries.
During the configuration of the microplan, there will be no users belonging to the ‘Microplan estimation viewer’ role assigned to the ongoing microplan at first. The system administrator will have to click on the button ‘Assign Microplan Estimation Viewers’ to start assigning the required users to the ongoing microplan.
Once the system administrator clicks on the ‘Assign Microplan Estimation Viewers’ button, he/she will be prompted a pop-up to assign the users with the ‘Microplan Estimation Viewers’ role to the ongoing microplan.
Here, the system admin will be able to assign/deassign a user to the ongoing microplan. The content of the pop-up are -
Search filters - The system admin will be able to search a user using the ‘User’s name’ and ‘User’s contact number’.
Validation: Partial string search should be allowed
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - The system administrator will be able to choose the administrative hierarchy from the dropdown. The system admin can choose one administrative hierarchy at a time. The system admin can’t choose the highest administrative hierarchy (Eg: Country) and the lowest administrative hierarchy (Eg: Village/Settlement) from the dropdown.
Administrative area - Upon choosing the administrative hierarchy, the system administrator will be able to choose the administrative areas for the chosen administrative hierarchy. The system administrator will be able to choose one or multiple administrative areas at a time. The list of administrative areas should be shown along with their respective parent boundaries.
Action - This capability will let the system administrator to assign/deassign users of the chosen role to the ongoing microplan.
This pop-up shows the actions that the user can take. The ‘Assign’ button should only be enabled if the system administrator has chosen the administrative hierarchy and the administrative area for a particular user belonging to the role chosen.
Once the system administrator has assigned all the required users to the microplan, the list of assigned users and their details will be displayed on the screen. Content of the screen are -
Search assigned users - The system admin will be able to search a user using the ‘User’s name’.
Validation: Partial string search should be allowed
Assign users - This action will let the system administrator to assign/deassign users to the microplan.
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be fetched from the user data that will be used while assigning the user to the microplan.
Administrative area - This will be fetched from the user data that will be used while assigning the user to the microplan.
Once all the required users are added to the microplan, the system administrator will click on the ‘Save And Proceed’ button to go to the next role assignment screen.
Validations for the ‘Microplan estimation viewer’ role:
(Validation criteria for warning messages (Microplan estimation viewer)
Note: It’s not mandatory to assign the Microplan estimation viewer to a microplan. The system administrator can skip and go to the next role management screen without assigning the users with Microplan estimation viewer role.
Role configuration - Facility catchment assigner
This role will have access to assign the facility to the catchment areas of the assigned administrative boundary.
This screen will be used to configure the ‘Facility catchment assigner’ user role. The assigned facility catchment assigner will be allowed to map the campaign facilities or point of services to the catchment areas (Eg: Villages/Settlements) of the assigned boundaries.
During the configuration of the microplan, there will be no users belonging to the ‘Facility catchment assigner’ role assigned to the ongoing microplan at first. The system administrator will have to click on the button ‘Assign Facility Catchment Assigner’ to start assigning the required users to the ongoing microplan.
Once the system administrator clicks on the ‘Assign Facility Catchment Assigner’ button, he/she will be prompted a pop-up to assign the users with ‘Facility Catchment Assigner’ role to the ongoing microplan.
Here, the system admin will be able to assign/deassign a user to the ongoing microplan. The content of the pop-up are -
Search filters - The system admin will be able to search a user using the ‘User’s name’ and ‘User’s contact number’.
Validation: Partial string search should be allowed
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - The system administrator will be able to choose the administrative hierarchy from the dropdown. The system admin can choose one administrative hierarchy at a time. The system admin can’t choose the highest administrative hierarchy (Eg: Country) and the lowest administrative hierarchy (Eg: Village/Settlement) from the dropdown.
Administrative area - Upon choosing the administrative hierarchy, the system administrator will be able to choose the administrative areas for the chosen administrative hierarchy. The system administrator will be able to choose one or multiple administrative areas at a time. The list of administrative areas should be shown along with their respective parent boundaries.
Action - This capability will let the system administrator to assign/deassign users of the chosen role to the ongoing microplan.
This pop-up shows the actions that the user can take. The ‘Assign’ button should only be enabled if the system administrator has chosen the administrative hierarchy and the administrative area for a particular user belonging to the role chosen.
Once the system administrator has assigned all the required users to the microplan, the list of assigned users and their details will be displayed on the screen. Content of the screen are -
Search assigned users - The system admin will be able to search a user using the ‘User’s name’.
Validation: Partial string search should be allowed
Assign users - This action will let the system administrator to assign/deassign users to the microplan.
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be fetched from the user data that will be used while assigning the user to the microplan.
Administrative area - This will be fetched from the user data that will be used while assigning the user to the microplan.
Once all the required users are added to the microplan, the system administrator will click on the ‘Save And Proceed’ button to go to the next role assignment screen.
Validations for ‘Facility catchment assigner’ role:
(Validation criteria for warning messages (Facility catchment assigner)
Note: It’s not mandatory to assign Facility catchment assigner to a microplan. The system administrator can skip and go to the next role management screen without assigning the users with Facility catchment assigner role.
Role configuration - Population data approver
This role will have access to validate & approve the population data for the villages of the assigned administrative boundary.
This screen will be used to configure the ‘Population data approver’ user role. The assigned user will be able to validate and approve the population data uploaded by the system administrator while setting up the microplan. The user will only be able to act on the population data of the villages that are assigned to his administrative boundaries.
During the configuration of the microplan, there will be no users belonging to the ‘Population data approver’ role assigned to the ongoing microplan at first. The system administrator will have to click on the button ‘Assign Population Data Approver’ to start assigning the required users to the ongoing microplan.
Once the system administrator clicks on the ‘Assign Population Data Approver’ button, he/she will be prompted a pop-up to assign the users with ‘Population Data Approver’ role to the ongoing microplan.
Here, the system admin will be able to assign/deassign a user to the ongoing microplan. The content of the pop-up are -
Search filters - The system admin will be able to search a user using the ‘User’s name’ and ‘User’s contact number’.
Validation: Partial string search should be allowed
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - The system administrator will be able to choose the administrative hierarchy from the dropdown. The system admin can choose one administrative hierarchy at a time. The system admin can’t choose the highest administrative hierarchy (Eg: Country) and the lowest administrative hierarchy (Eg: Village/Settlement) from the dropdown.
Administrative area - Upon choosing the administrative hierarchy, the system administrator will be able to choose the administrative areas for the chosen administrative hierarchy. The system administrator will be able to choose one or multiple administrative areas at a time. The list of administrative areas should be shown along with their respective parent boundaries.
Action - This capability will let the system administrator to assign/deassign users of the chosen role to the ongoing microplan.
This pop-up shows the actions that the user can take. The ‘Assign’ button should only be enabled if the system administrator has chosen the administrative hierarchy and the administrative area for a particular user belonging to the role chosen.
Once the system administrator has assigned all the required users to the microplan, the list of assigned users and their details will be displayed on the screen. Content of the screen are -
Search assigned users - The system admin will be able to search a user using the ‘User’s name’.
Validation: Partial string search should be allowed
Assign users - This action will let the system administrator to assign/deassign users to the microplan.
Name of the user - This will be fetched from the user management module for the chosen role.
Contact number of the user - This will be fetched from the user management module for the chosen role.
Email ID of the user - This will be fetched from the user management module for the chosen role.
Administrative hierarchy - This will be fetched from the user data that will be used while assigning the user to the microplan.
Administrative area - This will be fetched from the user data that will be used while assigning the user to the microplan.
Once all the required users are added to the microplan, the system administrator will click on the ‘Save And Proceed’ button to go to the next role assignment screen.
Validations for ‘Population data approver’ role:
(Validation criteria for warning messages (Population data approver
Note: It’s not mandatory to assign Population data approver to a microplan. The system administrator can skip and go to the next role management screen without assigning the users with Population data approver role.
View summary page -
Actor: System administrator/Program manager
Administrative boundary: National/Country
Once the microplan setup is completed, the user can review all the data configured before finalizing the microplan setup. The summary page will give the user the ability to review the configured data for each module. The summary page will let users edit the configured data if required.
The user will be allowed to edit each section of the summary screen as required.
The user will be allowed to download the uploaded file wherever there is file uploaded.
Once clicked on the ‘Edit’ button, the user will be redirected to the section of the microplan setup that needs to be edited.
Upon finalisation, the user will click on the ‘Complete setup’ button to complete the microplan setup for the supervisors to use further.
Sending email notifications to Microplan users -
Actor: System administrator/Program manager
Administrative boundary: National/Country
Once the microplan setup is completed, the users whose roles are configured by the system administrator will get an email notification mentioning their user login credentials and URL to the microplan platform or the data collection app. The email will be sent to the users who have valid email IDs registered during the role mapping. The email will also be sent to a common email address that is accessible by the supervisors.
Note: This should be configurable. If the implementation partner wants to enable email notification, then we should enable this.
Email for the microplan platform users
Content of the email of microplanning users:
From: Email of the implementation partner
To: Registered microplan user’s email ID and the common email ID of the implementation partner
Subject: Login credentials for microplanning platform
Body:
Hi {User’s name},
Below are the login credentials to access the microplanning platform -
URL: {website URL}
Username: {Username}
Password: {Password}
Thank you,
{Implementation partner}
Validation: If a new user is created post-microplan setup, the email will be sent to the new user only.
Email for the data collectors
Content of the email of data collector users:
From: Email of the implementation partner
To: Registered data collector email ID and the common email ID of the implementation partner
Subject: Login credentials for data collection app
Body:
Hi {User’s name},
Below are the login credentials to access the data collection app -
App link: {App download link}
Username: {Username}
Password: {Password}
Thank you,
{Implementation partner}
Landing page for system administrators -
Actor: System administrator/Program manager
Administrative boundary: National/Country
This is the landing page for the system administrator where the user can perform 3 actions:
Setup Microplan: The system administrator will be able to set up the microplan from scratch for a campaign
Open microplans: The system administrator will be able to see the list of campaign microplans in this page and perform certain actions on each microplan, if required
User management: The system administrator will be able to manage microplanning users using the user management module
Logout: The system administrator will be able to log out from the dashboard if he is not required to perform any action
‘Open saved microplans’ module:
This is the screen for the system administrator to check out the list of microplans and perform certain actions if required
Content of the screen:
Search microplan: The user can search microplan using the microplan name. The search can be a partial string match to show the list of microplans that have partially matching string that is typed
Tab filter based on microplan status: The user will be able to filter out and see the list of microplans concerning the microplan status. The microplan status are -
- All - This is default tab that will be chosen where the user can see the list of all microplans irrespective of their status
- Drafted setup - This is the status of the microplan when the system admin has partially configured the microplan and hasn’t completed the setup yet
- Completed setup - This is the status of the microplan when the system admin has created the microplan setup and the microplanning users haven’t yet opened the microplan to perform the activities (approve population data, facility catchment mapping, edit/approve microplan estimation, etc.) defined as per the role. This status will be fetched from the Microplan dashboard of the supervisors.
- Validation in progress - This is the status of the microplan when the user has started working on the microplan. This status will be fetched from the Microplan dashboard of the microplanning users.
- Microplan finalised - This is the status of the microplan when the user has performed all the activities on the microplan and finalised the microplan estimation. This status will be fetched from the Microplan dashboard of the microplanning users.
Microplan name: This shows the name of the microplan that the user has set while setting up the microplan
Microplan status: This shows the different status of a microplan while the microplan goes through a series of operational changes.
Campaign disease: This shows the campaign disease for which the microplan is being configured
Campaign type: This shows the type of campaign for which the microplan is being configured
Distribution strategy: This shows the distribution strategy to be used for the campaign execution
Action: The user will be able to perform certain actions on the microplan. The actions are -
- Edit setup - The user will be able to edit any or all of the segments of the microplan (Except campaign details segment) when the status of the microplan is ‘Drafted setup’. Once the status of the microplan changes to ‘Validation in progress’ or ‘Completed setup’, then the system administrator will be able to edit only the ‘User access management’ segment for edit, add or remove microplanning users.
- View summary - The user will be able to view a summary of the microplan that is setup successfully. The status of the microplan should be ‘Completed setup’, ‘Validation in progress’ and ‘Finalised microplan’. If microplan status is ‘Drafted setup’, the ‘View summary’ option should be hidden for the microplan from action dropdown.
- Duplicate setup - The user will be able to copy the setup configuration of the microplan and create a new microplan with a new name and copied microplan data. On click of ‘Copy’, the user will be re-directed to the first screen of the microplan setup with details already filled. The status of the microplan should be ‘Completed setup’, ‘Validation in progress’ and ‘Finalized microplan’. If microplan status is ‘Drafted setup’, the ‘Duplicate setup’ option should be hidden for the microplan from action dropdown.
‘User management’ module:
This is the screen for managing the users for the microplanning platform by the system administrator.
Content of the screen -
Name search - The system administrator should be able to search for the registered user using his/her name.
Contact number search - The system administrator should be able to search for the registered user using his/her mobile number.
Role filters - The system administrator should be able to filter the users registered in the microplanning platform using the role filters.
User details - This will have the required details of the registered users such as:
Name
Contact number
Role
Edit user details - Each user row should be clickable and on click of that, health HRMS edit user screen will open up. The user can edit below fields -
Name of the user
Email ID of the user
Add/remove user’s role
Activate/Deactivate the user
Bulk upload users - This is the capability that the system admin will have to add new users to the microplanning platform.
Here, the system admin can upload the user details by filling up the template attached above. All uploaded users will be part of the microplanning platform. The uploaded users will be able to access the microplans that they will be assigned to using the access control configuration.
The content of the template are -
Read me - This sheet will have the details of how to fill the user template excel and upload it for user registration.
User roles - This sheet will have the list of roles available for user registration and the description of each role.
Role mapping for each sheet - There will be a sheet defined in the template for each role available. Inside each of the role sheet, the system admin can fill user details with -
- Name - Name of the user who will be using the microplanning platform.
Validation: This is a mandatory field in the template.
- Contact number - Contact number of the person who will be using the microplanning platform.
Validation: This is a mandatory field in the template.
- Email ID - Email ID of the person who will be using the microplanning platform.
Validation of the template uploaded -
The name is the mandatory column to be filled by the system admin in the upload template. If the name is missing for the microplanning users while uploading the template, then show error ‘The ‘name’ is a mandatory field in the file, please update and re-upload’.
The contact number is the mandatory column to be filled by the system admin in the upload template. If the contact number is missing for the microplanning users while uploading the template, then show error ‘The ‘contact number’ is a mandatory field in the file, please update and re-upload’.
There should be a validation on contact number w.r.t the countries. If the contact number isn’t matching with the country’s standard structure, then show the error message ‘The ‘contact number’ entered is invalid, please update and re-upload’.
There can’t be duplicate users uploaded in the system. If a contact number of a microplanning user is already registered, then show an error message ‘An user with duplicate contact details already exists in the system’.
While uploading the template, if a user with the same contact number exists in a different role sheet with different name or email ID, show an error message ‘User details for the same contact number isn’t matching. Please check the user’s name or email ID.’
A user with ‘Microplan approver’ role can’t be assigned to ‘National microplan approver’ role. If this is the case, show an error message ‘An user with Microplan approver role can’t be assigned to National microplan approver role.’
A user with the ‘Facility catchment assigner’ role can’t be assigned to the ‘National facility catchment assigner’ role. If this is the case, show an error message ‘An user with Facility catchment assigner role can’t be assigned to National facility catchment assigner’.
A user with the ‘Population data approver’ role can’t be assigned to ‘National population data approver’ role. If this is the case, show an error message ‘An user with Population data approver role can’t be assigned to National population data approver’.
Note: Use the same format of showing errors in the user upload module as the ‘Data management - Population upload’ module.
When the user file is successfully uploaded, below is the UI that shows the file uploaded -
The user can download the file that is already uploaded
The user can re-upload the uploaded file if required
The user can view the content of the uploaded file by clicking on the file name, that is uploaded
Download user data -
This is the capability that will be used by the system administrator to download the user credentials of the registered users.
Content of the screen:
File name and attachment - This will have the name of the file with a hyperlink to view & download the file.
- The downloaded file will have all the details of the file that was uploaded, alongwith the user login credentials for each of the users in the file.
- The downloaded file will have the login credentials that were generated by the system itself for the first time when the file was uploaded and submitted successfully.
File uploaded by - This will show the name of the system administrator who had uploaded and submitted the file.
File uploaded time - This will show the timestamp of the file uploaded by the system administrator.
Validation: The timestamp needs to be in the international format of “DD MMM YYYY, HH:MM AM/PM”.
13. Showing ‘Last updated by’ information -
There is a possibility that multiple system administrators are working on the same microplan, to keep the traceability of who made the last changes, it’s important to show the ‘Last updated by “user’s name” at DD:MM:YYYY HH:MM’ in the dashboard for easy identification and traceability.
Editing of microplan setup -
Actor: System administrator/Program manager
Administrative boundary: National/Country
This will let the user edit the microplan setup as required.
The user will be able to edit any or all of the segments of the microplan (Except campaign details and campaign name segment) when the status of the microplan is ‘Drafted setup’.
Once the status of the microplan changes to ‘Completed setup’, ‘Validation in progress’, then the system administrator will be able to edit only the user access control/role management segment for assign/deassign a user to the microplan.
What are the changes that can be made in the microplan setup and what impact will it have on other modules?
The campaign details segment can’t be changed once the user goes to the next screen. There should be a warning pop-up to be shown to the user once the user clicks on the ‘Save & Next’ button.
Warning message: The campaign details can not be changed once saved, please confirm?
Action: The user can either ‘Cancel’ or ‘Confirm’
The microplan name can’t be changed once the user goes to the next screen. There should be a warning pop-up to be shown to the user once the user clicks on the ‘Save & Next’ button.
Warning message: The campaign name can not be changed once saved, please confirm?
Action: The user can either ‘Cancel’ or ‘Confirm’
The user can come back and make changes or update the boundary data. There should be a one-time pop-up/user consent to be shown to the user once the user tries to select a new boundary or unselect an already selected boundary.
Warning message: The uploaded population and facility data will be affected if you make changes to the boundary.
Action: The user can either click on ‘No, I don’t want to change’ or ‘Yes, I want to change’.
The user can come back and make changes or update the data management content. No warning messages will be displayed.
The user can come back and make changes or update the microplan assumption questionnaire. There should be a one-time pop-up/user consent to be shown to the user once the user tries to change any of the question’s dropdown or radio buttons.
Warning message: The campaign assumptions and formula configurations will be affected if you make changes to the questions.
Action: The user can either click on ‘No, I don’t want to change’ or ‘Yes, I want to change’.
The user can come back and make changes or update the microplan assumptions values, if already saved. No warning messages will be displayed.
The user can come back and make changes or update the microplan formula configurations. No warning messages will be displayed.
The user can come back and make changes or update the user management module such as add/remove users to the microplan. No warning messages will be displayed.
Data collector’s flow:
Data collector app -
Actor: Data collector
Administrative boundary: Village/Lowest boundary hierarchy
This app will be used by the users with the ‘Data collector’ role to collect the village population data, along with other geographical information. The user’s goal is to make sure that the correct population and geographical data have been collected for the villages to make an informed microplan estimation.
Note: The app functionalities should be offline first
Content of the screen -
User ID: The data collector will have to enter the username that he has received for logging in and collecting the village data.
Password: The data collector will have to enter the password that he has received for logging in and collecting the village data. The password will be hidden while typing in.
View password: The user can view the password that he has entered.
Login: This is the action button using which the user will log in and land on the homepage.
Forgot password?: If the user forgets his password, the user can click on the ‘Forgot password’ button and the app should give the message “Please connect with your supervisor or administrator to retrieve the password”
Choose language: The user will be able to choose the language for the app content.
Content of the screen -
Population: Upon logging in, the user will land on the homepage where the ‘Population’ functionality will let the user collect village population data for the respective villages
Data sync: If the data is submitted in the absence of internet connection, the data will not be synced with the server. In such cases, the user can see how many records are being unsynced and needs proper internet connection to sync with the server.
Note: Auto data sync needs to be enabled. So, whenever there is an internet connection, the app should auto sync the unsynced data.
Logout: The user can logout from the application by navigating to the hamburger menu and clicking on the logout button. The user will be redirected to the login page accordingly.
Help: The user can understand the modules present in the screen by clicking on ‘help’ button. Help information for the ‘Population’ module - ‘The user can collect population and related information for every assigned boundaries’
Content of the screen -
Search enabled dropdown: The user will be asked to select the village for which the population data needs to be collected. This will be a search enabled dropdown where the user can search for the specific village assigned to him. All the villages should be listed in the dropdown in alphabetical order.
Submitted village data: The user will be able to see the villages whose data has already been submitted. The ‘tick’ mark shows that the village data for that specific village has been collected already. The user can only view the data for those villages where the data has been collected and submitted.
Back: The user will be able to go back to the homepage using the ‘Back’ button.
Content of the screen for bednet campaign data collection form -
Village name: The user will be able to see which village he/she has chosen on the screen.
Uploaded village population: The user will be able to see the uploaded village population, which is the total village population data that was uploaded by the system admin while setting up the microplan.
Uploaded target population: The user will be able to see the uploaded target population of the village, which is the targeted village population data that was uploaded by the system admin while setting up the microplan.
Confirm the total population of the village: The user will be asked to confirm the total population of the village. It’s a mandatory input field.
Validation: The input value should be a whole number. If it’s an invalid entry, show the error message ‘Please enter a whole number’.
Confirm the target population of the village: The user will be asked to confirm the target population of the village. It’s a mandatory input field.
Validation: The input value should be a whole number. If it’s an invalid entry, show the error message ‘Please enter a whole number’.
Accessibility section - Choose village road condition: The user will be asked to choose the village road condition. It’s a dropdown and the user will be given 4 options to choose from -
a. Concrete
b. Gravel
c. Dirt
d. No road
Note: The option can be kept enabled/disabled depending on the program’s requirements.
Accessibility section - Choose village terrain:The user will be asked to choose the village terrain structure. It’s a dropdown and the user will be given 4 options to choose from -
a. Mountain
b. Forest
c. Desert
d. Plain
Note: The option can be kept enabled/disabled depending on the program’s requirements.
Accessibility section - Choose transportation mode to the village: The user will be asked to choose the transportation access to the village. It’s a checkbox-enabled dropdown and the list will be populated depending on the vehicles configured for the campaign by the system administrator while doing the microplan setup. The data collector can choose multiple transportation options as it’s going to be checkboxes. If the user doesn’t find the option to choose, he will choose ‘Others’.
If the user chooses ‘Others’ as the option, he will be asked to ‘Enter the transportation mode’.
Note: The option can be kept enabled/disabled depending on the program’s requirements.
Security section - Is your village prone to civil unrest like violent protests, riots, etc.?: The user will be asked to choose how prone the village is to civil unrest or protest. Below are the options given to the user to choose from -
a. All the time (Atleast once a month)
b. Often (Atleast once a year)
c. Rarely (Once in 2-3 years)
d. Never
Note: The option can be kept enabled/disabled depending on the program’s requirements.
Security section - How often do the security forces patrol the village?: The user will be asked how often do the security forces patrol the village. It’s a dropdown option for the user to choose from. Below are the options given to the user to choose from -
a. Everyday
b. Often (Atleast once a week)
c. Rarely (Once in a month)
d. Never
Note: The option can be kept enabled/disabled depending on the program’s requirements.
Comment: Before submission of the collected data, the user needs to add a comment. It’s a mandatory input field.
Validation: The maximum length of the comment is 140 characters. If the user tries to submit the data without adding a comment, then show the error message “Please enter comment before submission”.
Submit: Once the data form is filled and submitted, the user will be redirected to the village selection page to select a new village for data collection.
Note: If the programme requires deleting existing content or adding new information with multiple dropdown choices or input values in the screen, that should be done by the impel team.
Once the data is filled, the data collector will submit the data, which will be reviewed and taken action by the ‘Population data approver’ role user.
If the user chooses a village, whose data has already been collected and submitted, then he will be able to review the submitted data.
If the user clicks on ‘Back’, the user will be redirected to the village selection screen to choose a new village for data collection and submission.
Content of the screen for SMC campaign data collection form -
Village name: The user will be able to see which village he/she has chosen on the screen.
Uploaded village population: The user will be able to see the uploaded village population, which is the total village population data that was uploaded by the system admin while setting up the microplan.
Uploaded target population (Age 3-11 months): The user will be able to see the uploaded target population between the age 3-11 months of the village, which is the targeted village population data that was uploaded by the system admin while setting up the microplan.
Uploaded target population (Age 12-59 months): The user will be able to see the uploaded target population between the ages 12-59 months of the village, which is the targeted village population data that was uploaded by the system admin while setting up the microplan.
Confirm the total population of the village: The user will be asked to confirm the total population of the village. It’s a mandatory input field.
Validation: The input value should be a whole number. If it’s an invalid entry, show the error message ‘Please enter a whole number’.
Confirm target population of the village (Age 3-11 months): The user will be asked to confirm the target population of the village between the ages 3-11 months. It’s a mandatory input field.
Validation: The input value should be a whole number. If it’s an invalid entry, show the error message ‘Please enter a whole number’.
Confirm target population of the village (Age 12-59 months): The user will be asked to confirm the target population of the village between the ages 12-59 months. It’s a mandatory input field.
Validation: The input value should be a whole number. If it’s an invalid entry, show the error message ‘Please enter a whole number’.
Accessibility section - Choose village road condition: The user will be asked to choose the village road condition. It’s a dropdown and the user will be given 4 options to choose from -
a. Concrete
b. Gravel
c. Dirt
d. No road
Note: The option can be kept enabled/disabled depending on the program’s requirements.
9. Accessibility section - Choose village terrain: The user will be asked to choose the village terrain structure. It’s a dropdown and the user will be given 4 options to choose from -
a. Mountain
b. Forest
c. Desert
d. Plain
Note: The option can be kept enabled/disabled depending on the program’s requirements.
10. Accessibility section - Choose transportation mode to the village: The user will be asked to choose the transportation access to the village. It’s a checkbox-enabled dropdown and the list will be populated depending on the vehicles configured for the campaign by the system administrator. The data collector can choose multiple transportation options as it’s going to be checkboxes. If the user doesn’t find the option to choose, he will choose ‘Others’.
If the user chooses ‘Others’ as the option, he will be asked to ‘Enter the transportation mode’.
Note: The option can be kept enabled/disabled depending on the program’s requirements.
11. Security section - Is your village prone to civil unrest like violent protests, riots, etc.?: The user will be asked to choose how prone the village is to civil unrest or protest. Below are the options given to the user to choose from -
All the time (Atleast once a month)
Often (Atleast once a year)
Rarely (Once in 2-3 years)
Never
Note: The option can be kept enabled/disabled depending on the program’s requirements.
Security section - How often do the security forces patrol the village?: The user will be asked how often the security forces patrol the village. It’s a dropdown option for the user to choose from. Below are the options given to the user to choose from -
a. Everyday
b. Often (Atleast once a week)
c. Rarely (Once in a month)
d. Never
Note: The option can be kept enabled/disabled depending on the program’s requirements.
Comment: Before submission of the collected data, the user needs to add a comment.
Validation: The maximum length of the comment is 140 characters. If the user tries to submit the data without adding a comment, then show the error message “Please enter comment before submission”.
Submit: Once the data form is filled and submitted, the user will be redirected to the village selection page to select a new village for data collection.
Note: If the program requires deleting existing content or adding new information with multiple dropdown choices or input values in the screen, that should be done by the impel team.
Once the data is filled, the data collector will submit the data, which will be reviewed and taken action by the ‘Population data approver’ role user.
Supervisor’s flow :
Landing page for the supervisors -
Actor: Supervisor (Population data approver, Microplan viewer, Microplan approver, and Facility catchment mapper)
Administrative boundary: Country (Highest boundary), Province, Districts, Admin post, Locality (Second lowest boundary)
Once the supervisor logs in using the login credentials received via email, the supervisor will be able to perform only 2 actions here -
Open microplans: The user will be able to click on ‘My Microplan’ to get the list of all the microplans that he is part of. If a user is a part of 1 or more campaign microplanning processes, he/she will be able to see the list after he clicks on the ‘My Microplan’ link.
Logout: The supervisor will be able to log out from the dashboard if he is not required to perform any action.
Content of the screen:
Search microplan: The user can search microplan using the microplan name. The search can be a partial string match to show the list of microplans that have a partially matching string that is typed
Tab filter based on microplan status: The user will be able to filter out and see the list of microplans concerning the microplan status. The status are -
- All - By default ‘All’ tab will be chosen and the user will be able to see all the microplans that are assigned to him irrespective of the microplan status.
- Execution to be done - This is the status of the microplan when the user hasn’t yet opened the microplan to perform the activities (approve population data, facility catchment mapping, edit/approve microplan estimation, etc.) defined as per the role.
- Execution in progress - This is the status of the microplan when the user has started working on the microplan by clicking on the ‘Start’ button.
Validation: The user with the ‘Population data approver’ role will be able to click on ‘Start’ as without the population data being approved, the microplan estimation won’t be executed. For other roles, the ‘Start’ button should be disabled.
- Execution done - This is the status of the microplan when the user has performed all the activities on the microplan and finalized the microplan estimation.
Microplan name: This shows the name of the microplans that are assigned to the user.
Microplan status: This shows the different status of a microplan while the microplan goes through a series of operational changes.
Campaign disease: This shows the campaign disease for which the microplan is being configured.
Campaign type: This shows the type of campaign for which the microplan is being configured.
Distribution strategy: This shows the distribution strategy to be used for the campaign execution.
Action: The user will be able to perform certain actions on the microplan. The actions are -
- Start - When the microplan status is ‘Execution to be done’, that means the work on microplan hasn’t yet started by any of the users. And this is when the ‘Start’ button will be reflected corresponding to the microplan. When the user clicks on the ‘Start’ button, the status will change to ‘Execution in progress’.
- Edit - When the microplan status is ‘Execution in progress’, that means the working on microplan has started by any of the users. And this is when the ‘Edit’ button will be reflected corresponding to the microplan.
- Download estimation - When the microplan status is ‘Execution done’, that means the microplan estimation has been finalized by the national level user. And this is when the ‘Download estimation’ button will be reflecting corresponding to the microplan. The user will be able to download the excel file of the microplan estimation.
Multi-role activity view -
Actor: Supervisor (Population data approver, Microplan viewer, Microplan approver and Facility catchment mapper)
Administrative boundary: Country (Highest boundary), Province, Districts, Admin post, Locality (Second lowest boundary)
This view will give the users the activities they can perform on the platform concerning the role assigned to them. A user can be assigned to multiple roles, and depending on the role assigned the user will be able to see the options on the screen.
Once the user takes an action of ‘Start’ or ‘Edit’ for a microplan, the user will be redirected to this available activity screen where the user will be able to take appropriate actions as per the role defined. The activities that will be listed are -
the Approve population data - A user with ‘Population data approver’ role will be able to see the action tab of ‘Approve population data’.
Assign facilities to villages - A user with the ‘Facility catchment mapper’ role will be able to see the action tab of ‘Assign facilities to villages’.
Geospatial map view - Any microplan user irrespective of role defined will be able to see this action tab.
Approve microplan estimations - A user with ‘Microplan approver’ role will be able to see the action tab of ‘Approve microplan estimations’.
View microplan estimations - A user with ‘Microplan viewer’ role will be able to see the action tab of ‘View microplan estimations’.
To access the ‘Assign facilities to villages’ tab, it’s important that the country level ‘Population data approver’ finalizes the population data for the campaign boundary. If the population data is not finalized, then the ‘Assign facilities to villages’ tab will be disabled and users will be able to see a message “The population data for the microplan hasn’t been approved yet. Please come back later.” on hovering over the ‘Assign facilities to villages’ tab.
To access the ‘Geospatial map view’, ‘Approve microplan estimations’ and ‘View microplan estimations’ tabs, it’s important that the country level ‘Facility catchment mapper’ finalizes the facility-to-catchment mapping for all the villages within the campaign zone. If the facility-catchment mapping is not finalized, then the ‘Geospatial map view’, ‘Approve microplan estimations’ and ‘View microplan estimations’ tabs will be disabled and users will be able to see a message “The facility to catchment area assignment for the microplan hasn’t been finalised yet. Please come back later.” on hovering over the ‘Assign facilities to villages’ tab.
Population data approver flow -
Actor: Supervisor (Population data approver)
Administrative boundary: Country (Highest boundary), Province, Districts, Admin post, Locality (Second last boundary)
This is the flow for approving the village population data that is either uploaded by the system admin or collected by the data collector. Approving population data is crucial as the microplan estimation will be happening concerning the population of the village that is approved.
Population data approvers can act on different administrative hierarchies and depending on the hierarchy and boundaries assigned, the villages will be assigned to the user for approving the population data. For example, the Population data approver can belong to a country, province, district, administrative post, locality and with respect to the boundaries assigned, he will be able to see the village information.
The final approver for the population data of the country will always be the national level ‘Population data approver’ where all the villages and its population will be added up to show the country level population.
Note: The design is showing ‘District’ level population approver screen but a population data approver can belong to any administrative hierarchy of the country.
This is the landing page for the ‘Population data approver’ user where he/she will see the population and related information of the villages that are part of the administrative boundaries assigned to him. The user can check out the detailed information and make changes in the population and related data and send the changes for approval. If no changes are required in the population data, the user can directly validate the village population.
Content of the landing page -
Dynamic boundary filters on top concerning parent and child administrative hierarchy - This is a dynamic filter that will be given to the user for filtering out specific boundaries. This will be a search-enabled dropdown for every filter content. The filters will be added or removed depending on the parent hierarchy assigned to the user. For example, if the user belongs to district hierarchy (Parent), then all child hierarchies and their boundaries will be part of the filter. The user can clear the selected filter by clicking on the ‘Clear Filter’ button.
Dynamic dashboard metrics - There will be dynamic metrics that will be shown to the user depending on the filters chosen. The important metrics that need to be shown on the dashboard are -
a. Uploaded target population - This metric will show the aggregated target population that is uploaded and it will change as per the filters chosen. This is for a bednet campaign.
b. Confirmed target population - This metric will show the aggregated confirmed target population and it will change as per the filters chosen. This is for a bednet campaign.
c. Uploaded target population (Age 3 - 11 months) - This metric will show the aggregated target population (Age 3 - 11 months) that is uploaded and it will change as per the filters chosen. This is for a SMC campaign.
d. Confirmed target population (Age 3 - 11 months) - This metric will show the aggregated confirmed target population (Age 3 - 11 months) and it will change as per the filters chosen. This is for a SMC campaign.
e. Uploaded target population (Age 12 - 59 months) - This metric will show the aggregated target population (Age 12 - 59 months) that is uploaded and it will change as per the filters chosen. This is for a SMC campaign.
f. Confirmed target population (Age 12 - 59 months) - This metric will show the aggregated confirmed target population (Age 12 - 59 months) and it will change as per the filters chosen. This is for a SMC campaign.
g. Uploaded total population - This metric will show the aggregated total population that is uploaded and it will change as per the filters chosen.
h. Confirmed total population - This metric will show the aggregated confirmed total population and it will change as per the filters chosen.
Filters on the action items on the user - This filter will help the user to filter out the villages that need some action. Below are the filters that will be shown to the user:
a. Villages with pending validation - This filter will show the list of villages that are pending to be validated by the user. The user will be able to see the list of villages whose actions are pending on the user as well as on the users that belong to the child boundaries of the parent district level data approver. This filter will be further segregated as -
i. Pending on me - This will show the list of the villages that needs to be validated by the assigned user of the ‘district’. This will also show a metric - the number of villages that are pending to be validated by the user out of the total number of villages belonging to the user’s assigned boundaries, for example, 5/30 villages to be validated. This should be by default chosen when the user lands on the page.
ii. Pending on subordinates - This will show the list of the villages that need to be validated by the users that belong to the child boundaries of the parent ‘district’. This will also show a metric - the number of villages that are pending to be validated by the subordinates out of the total number of villages belonging to the user’s assigned boundaries, for example, 15/30 villages to be validated.
Note: A data approver belonging to a ‘district’ can validate the village population data of the villages that belong to the child boundaries of the ‘district’, even though those villages may have their own data approver assigned.
b. Validated villages - This filter will show the list of villages that are part of the user’s assigned boundary and those have been validated either by the user himself or his subordinates at the lower administrative hierarchy level. This will also show a metric - the number of villages that are validated out of the total number of villages belonging to the user’s assigned boundaries, for example, 25/30 villages are validated.
c. Villages with pending approval - This filter will show the list of villages whose population data (total population or target population) have been changed by the user’s subordinates at the lower administrative hierarchies. This will also show a metric - the number of villages that are pending for approval by the user, for example, 5 villages data to be approved. The assigned user who can see the pending approval villages here can perform 2 activities -
i. Check and approve the recommended village population data
ii. Send back the village data for correction to the user who sent the village data for approval
Data content of the landing page -
Here the user will be able to see the basic information related to the villages that are part of his administrative hierarchy. The data that will be available are -
a. Village - The list of the villages that are part of the user’s administrative hierarchy. There will be a checkbox beside every village listed.
b. Uploaded total population - This will show the total population of the village whose data has been uploaded by the central team or microplan system administrator.
c. Confirmed total population - This will show the total population of the village whose data has been uploaded by the central team or microplan system administrator. This can later be edited.
d. Uploaded target population - This will show the target population of the village whose data has been uploaded by the central team or microplan system administrator. This is specifically for bednet campaigns.
e. Confirmed target population - This will show the target population of the village whose data has been uploaded by the central team or microplan system administrator. This is specifically for bednet campaigns. This can later be edited.
f. Uploaded target population (Age 3-11 months) - This will show the target population between age 3-11 months of the village whose data has been uploaded by the central team or microplan system administrator. This is specifically for SMC campaigns.
g. Confirmed target population (Age 3-11 months) - This will show the target population between age 3-11 months of the village whose data has been uploaded by the central team or microplan system administrator. This is specifically for SMC campaigns. This can later be edited.
h. Uploaded target population (Age 12-59 months) - This will show the target population between age 12-59 months of the village whose data has been uploaded by the central team or microplan system administrator. This is specifically for SMC campaigns.
i. Confirmed target population (Age 12-59 months) - This will show the target population between age 12-59 months of the village whose data has been uploaded by the central team or microplan system administrator. This is specifically for SMC campaigns. This can later be edited.
j. Comment logs - This will show the status flow of a village and comments made while validating or making corrections to the village data. This comment logs will capture the comment made by the users in a timeline manner. For any action that the user takes such as ‘Validate’, ‘Send for data correction’, ‘Send for approval’ and ‘Approve’ the user has to enter a comment.
k. Edit confirmed population - This is an action that the user can take to update the population data of the village, if the user feels that the uploaded data is incorrect or has discrepancies. Upon editing, the village data will be submitted for approval by the user belonging to the next higher hierarchy. This will update the ‘Confirmed total population’ and ‘Confirmed target population’ of the village for the data approver.
Note: Edit population data option will not be provided to the users if they filter the villages by ‘Villages with pending approval’ and ‘Validated villages’ filter.
Action on the villages - There will be certain actions that the user can take on the villages depending on the filter chosen. The actions are -
a. Validate data - This action will be available for the filters chosen ‘Villages with pending validation’. More details will be provided below.
b. Send for correction - This action will be available for the filters chosen ‘Villages with pending approval’ and ‘Validated villages’. More details will be provided below.
c. Approve data - This action will be available for the filters chosen ‘Villages with pending approval’. More details will be provided below.
This functionality will give access to the assigned user to edit the village population data and submit it for approval to the supervisors belonging to the next higher hierarchy.
Note: The edit population data option will not be provided to the users if they filter the villages by ‘Villages with pending approval’ and ‘Validated villages’ filter.
Content of the screen -
Village name - This shows the name of the village that the user wants to edit the population data for.
Uploaded total village population - This shows the total village population uploaded by the system admin for the village.
Uploaded target village population - This shows the target village population uploaded by the system admin for the village. This is specifically for bednet campaigns.
Uploaded target village population (Age 3 - 11 months) - This shows the target village population (Age 3 - 11 months) uploaded by the system admin for the village. This is specifically for SMC campaigns.
Uploaded target village population (Age 12 - 59 months) - This shows the target village population (Age 12 - 59 months) uploaded by the system admin for the village. This is specifically for SMC campaigns.
Confirm total population of the village - This will have auto filled total population data captured by the data collector or population upload file, in case the village doesn’t have any data collector. The data approver can validate and edit the total population and it will be reflected in the ‘Collected total village population’ data column of the dashboard.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Confirm target population of the village - This will have auto filled target population data captured in the population upload file. This is specifically for bednet campaigns.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Confirm target population of the village (Age 3 - 11 months) - This will have auto filled target population (Age 3 - 11 months) data captured in population upload file. This is specifically for SMC campaigns.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Confirm target population of the village (Age 12 - 59 months) - This will have auto-filled target population (Age 12 - 59 months) data captured in the population upload file. This is specifically for SMC campaigns.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Actions buttons - The user will be able to perform either of the below actions here:
a. Send for approval - Once the user updates the population data, the user can send the changed data of the village for approval to the next higher administrative hierarchy data approver. To send corrected data for approval, the user must enter a comment sharing the reason for the change.
Validation: The max length of a comment is 140 characters.
b. Cancel - The user can cancel the update and return to the landing page.
The user can see the comment logs by clicking on the comment logs link. The user will be able to see the detailed action taken on a village along with the timestamp and comment details. This will help the supervisors to understand what actions have been taken in a village and who took the action. This will help in keeping traceability of the changes happening to a village.
The content of the comment logs are -
Status of the action - The user will be able to see the status of the actions taken by the other users. For every action, the status will be captured w.r.t the village and updated in the comment logs. There will be 4 status on a high level:
a. Data submitted - Once the village population data has been uploaded by the central/system admin, the status will be changed to ‘Data submitted’.
b. Sent for approval - Once the village population data has been changed by a user and forwarded for approval, the status will be changed to ‘Sent for approval’.
c. Approved - Once the user approves the recommended changes in the village population, it moves to ‘Approved’ status.
d. Validated - Once the village population data has been validated by the user or by the highest jurisdiction level data approver, the status will be changed to ‘Validated’ and the village will be moved to ‘Validated villages’ bucket.
e. Sent for correction - Once the village population data has been checked by the supervisor and supervisors decide to send the village data for correction, the status will be changed to ‘Sent for correction’.
User’s name and role - Whenever a user takes an action on the village and puts a comment, for every action, the user’s name and role will be captured and shown in the comment logs.
Timestamp - Whenever a user takes an action on the village and puts a comment, for every action, the timestamp of the action will be captured. It should be in the international timestamp format “YYYY-MM-DD HH:MM”.
Comment - Whenever a user takes an action on the village and puts a comment, it will be captured alongside the other details.
Workflow image for data validation and data approval -
Workflow for pending data validation - Upon landing, the user will be able to see the list of villages that are part of the administrative hierarchy assigned to the user and his subordinates. There will be a filter called ‘Villages with pending validation’, in this filter, the user will be able to see all the villages that need the user or his subordinates to take action. On this page, the user can take 2 important actions upon checking the village population data -
a. Validate the village data -
If the user chooses one or more villages and validates their data using the ‘Validate’ button, then the villages will be moved from the bucket of ‘Villages with pending validation’ to ‘Validated villages’. These validated villages will be seen by the user, his subordinates at the child administrative boundaries, and his/her superiors at the parent administrative boundaries. For example, if a district supervisor validates the village data, then it will be seen by the administrative post and locality-level data approvers that are part of the district, also, the validated villages will be seen by the province and country-level data approvers to which the district is linked. For validating a village, the user has to add a reason for validation as a comment. Below is the UI for the comment section to add the validation reason:
b. Send back for correction -
Once the validated villages start residing in the ‘Validated villages’ bucket, those villages will be shown to every user belonging to the parent and child administrative boundaries. The user at the higher administrative boundaries will have the access to send back the data for correction, in case the higher level supervisors aren’t satisfied with the validated village data. Once the data has been sent back for correction, the village will move from the ‘Validated villages’ bucket to the ‘Villages with pending validation’ bucket of the user who has validated it earlier. For sending back for correction, the user has to add a reason for sending back the data for correction as a comment. Below is the UI for comment section to add the validation reason:
Note: Send back for correction button will only be available to the users who validated the village data and to the users that reside in the higher administrative boundaries.
Workflow for pending data approval - Upon landing, the user will be able to see the list of villages that are part of the administrative hierarchy assigned to the user and his subordinates. There will be a filter called ‘Villages with pending validation’, in this filter, the user will be able to see all the villages that need the user or his subordinates to take action. On this page, the user can take 2 important actions upon checking the village population data -
a. Editing the village data - If the user feels that the uploaded data for a certain village is incorrect or out-dated, the user can recommend data changes for the village by clicking on the ‘Edit population data’ button.
Once the user edits the village population data, it will be sent to his next higher level supervisor for approval. The village will be moved from the ‘Villages with pending validation’ bucket to ‘Villages with pending approval’ bucket of the supervisor belonging to the next higher administrative hierarchy. For sending recommended village population data for approval, the user has to add a reason for sending recommended village population data for approval as a comment. Below is the UI for comment section to add the validation reason:
b. Approving the recommended changes in the village data -
The supervisors will be able to see the list of villages with pending approval in the ‘Villages with pending approval’ bucket. In this bucket, the supervisor can check and compare the village population data that is uploaded and then the recommended population data submitted by the subordinate for approval. Here, upon decision making, the supervisor data approver can take 2 actions:
i. Approve the recommended changes in the village data - If the supervisor data approver feels that the recommended changes in the village population is correct, then the data approver will approve the village population using the ‘Approve’ button (The user can choose multiple villages for approval at once). Upon approving the village population, the village will be moved from the assigned data approver’s ‘Villages with pending approval’ bucket to the next higher administrative hierarchy data approver’s ‘Villages with pending approval’ bucket. This workflow will go on until the national or highest administrative hierarchy level data approver validates the population data of the village. Once the changes reach the highest administrative hierarchy for approval, the village status will be ‘Validated’ and the village will reside in the ‘Validated villages’ bucket once approved by the highest administrative hierarchy. For every approval, the data approver needs to add a reason as a comment and that comment will be seen in the comment logs.
Note: The population data approver will be able to see and take actions on the pending approvals on him as well as the pending approvals on his subordinates.
ii. Sending data for correction - If the supervisor data approver at any higher administrative hierarchy feels that the recommended changes in the village population is incorrect, then the data approver will send the village population data for correction using the button ‘Send for correction’. Once the data is sent for correction, the village will be moved from the ‘Villages with pending approval’ bucket of the user to ‘Villages with pending validation’ bucket of the user who submitted the recommended village data changes. For every action of sending for correction, the data approver needs to add a reason as a comment and that comment will be seen in the comment logs.
Important validation: The village population data can’t be changed if the village resides in the ‘Villages with pending approval’ bucket.
View of detailed village data -
This is the redirected page that shows the detailed information of the village selected. When the user clicks on the village on the landing page, he will be redirected to a new page with the detailed information of the village.
Content of the detailed pop-up screen -
Boundary details - Depending on the boundary assigned, the user will be able see the boundary hierarchy and assigned boundaries, along with the child boundary hierarchy and their boundaries.
Uploaded target village population - This will show the system admin’s uploaded target population of the village. This is specifically for bednet campaigns.
Uploaded target village population (Age 3 - 11 months) - This will show the system admin’s uploaded target population (Age 3 - 11 months) of the village. This is specifically for SMC campaigns.
Uploaded target village population (Age 12 - 59 months) - This will show the system admin’s uploaded target population (Age 12 - 59 months) of the village. This is specifically for SMC campaigns.
Approve target population of the village - This will have auto filled target population data captured in the population upload file. In case the target population of the village is updated by the data approver, then the approved target population will be updated with the new updated target population. This is specifically for bednet campaigns.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Approve target population of the village (Age 3 - 11 months) - This will have auto filled target population (Age 3 - 11 months) data captured in population upload file. In case the target population of the village is updated by the data approver, then the approved target population will be updated with the new updated target population. This is specifically for SMC campaigns.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Approve target population of the village (Age 12 - 59 months) - This will have auto filled target population (Age 12 - 59 months) data captured in the population upload file. In case the target population of the village is updated by the data approver, then the approved target population will be updated with the new updated target population. This is specifically for SMC campaigns.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Uploaded total village population - This will show the uploaded total population of the village by the system admin.
Approve total population of the village - This will have auto filled total population data captured in the population upload file. In case the total population of the village is updated by the data approver, then the approved total population will be updated with the new updated total population.
Validation: The field should accept only numeric values and whole numbers. Error message when invalid entry happens “Population data must be a whole number”.
Assigned data approver - This will show the person who is assigned to approve the population data of the village.
Village accessibility level - This shows the accessibility level to a village. The village accessibility level can be edited by ‘Population data approver’, if required. This is an optional field.
There are 3 data parameters to access the accessibility level to the village -
a. Village road condition - The user will be asked to choose the road condition to the village using the data approver dashboard. There will be 4 options given to the user to choose from -
Concrete
Gravel
Dirt
No road
b. Village terrain - The user will be asked to choose the village terrain using the data approver dashboard. There will be 4 options given to the user to choose from -
Mountain
Forest
Plain
Desert
c. Transportation mode - The user will be asked to choose the transport mode available to reach the village using the data approver dashboard. The transportation mode will be fetched from the vehicle registration page. If the user doesn’t get the option to choose the transport mode, he can choose ‘Others’ as an option to add the transport mode to the vehicle. The new transport mode will be just temporarily created and it will not affect the vehicle registration module.
Village security level - The village security level will be edited by the ‘Population data approver’ user if required. This is an optional field.
There are 2 data parameters to access the security level of the village -
a. Is your village prone to civil unrest like violent protests, riots, etc.? - The user will be asked this question to answer using the data approver dashboard. There will be 4 options to choose from -
All the time (Atleast once a month)
Often (Atleast once a year)
Rarely (Once in 2-3 years)
Never
b. How often do the security forces patrol the village?
Everyday
Often (Atleast once a week)
Rarely (Once in a month)
Never
Comment logs - The data approver can check the comment logs in case a village is validated or sent for correction or sent for approval.
Use-case to cover: What if the country-level data approver changes/edits the village population data?
The country-level data approver can make population data changes for any village under his jurisdiction. Now, since the country-level data approver doesn’t have any superior role assigned above him, the changes will not go through any approval process. The country-level data approver can simply make the changes, add a reason for the changes, and save the changes. The status of the village will remain unchanged but all the changes should be logged in the comment and change logs.
Note - The final approver of the village population will be the national or highest administrative hierarchy data approver. The national level data approver will have a button called ‘Finalize Population Data’, and the button will only be enabled when the ‘Villages with pending validation’ is 0, ‘Villages with pending approval’ is 0, and ‘Validated villages’ is x/x, that is, if there are 500 villages in the campaign zone, then 500 villages should be in the validated status. Once the population data is finalised, there will be no action allowed on the dashboard. The user can just work with the filters to view the data but can’t make any changes. Once finalized, the estimation of bednets required per village and the total SPAQ required per village will be calculated.
The user will be able to see the message screen once the population data has been finalized by the national level Population data approver.
Facility catchment mapper flow -
Actor: Supervisor (Facility catchment mapper)
Administrative boundary: Country (Highest boundary), Province, Districts, Admin post, Locality (Second last boundary)
This is the flow for mapping the campaign facilities/POS to their catchment boundaries (villages). Mapping the facilities/POS to their catchment boundaries (villages) is crucial as the microplan estimation for the boundary (villages) will be happening w.r.t the facility/POS mapped and its type.
Facility catchment mappers can act on different administrative hierarchies and depending on the hierarchy and boundaries assigned, the facility catchment mapper will be able to see their assigned villages and facilities/POS for mapping. For example, the mapper can belong to a country, province, district, administrative post, or locality, and concerning the boundaries assigned, he/she will be able to see the respective villages and facilities/POS within the boundaries assigned.
This screen is the landing page for the mapper. In this screen, the mapper will be able to view all the facilities/POS and their details that are part of his administrative boundaries.
Validation: For the mapper to work on mapping facility/POS to their catchment areas, the population data for the campaign must be approved by the national level Population data approver.
Content of the screen -
Card showing villages with mapped facilities/POS - This card will show the count of the villages that belong to the mapper’s administrative boundary. It also shows the total number of villages (belonging to the mapper’s admin boundary) that have a catchment facility mapped.
Card showing facilities with mapped villages - This card will show the count of the facilities that belong to the mapper’s administrative boundary. It also shows the total number of facilities (belonging to the mapper’s admin boundary) that have a catchment village mapped.
Facility search - This will give the user the ability to search the specific facility that needs to be mapped to the catchment boundaries. The search needs to accept partial string match as well.
Filters - This will let the users to filter out the specific facilities that he needs to do the facility-catchment area mapping for. The user can filter out the facilities that he wants to map the catchment villages to. Below are the multi-select dropdown filters that the user will get -
a. Facility type - This will have the data of facility type defined during the instance creation
b. Facility status - This will have the facility status defined, which is either permanent or temporary
c. Is fixed post? - This will be an optional field. If the campaign distribution strategy is either ‘fixed post’ or ‘house-to-house and fixed post’, then this filter will be available for the user to choose
d. Residing village - This will have the list of all the villages that the facilities in the dashboard are part of
Facility name - This field shows the name of the facility that belongs to the user’s defined boundary.
Facility type - This field contains the type of the facilities that are listed in the dashboard.
Facility status - This field contains the status (Permanent/Temporary) of the facilities that are listed in the dashboard.
Capacity - This field contains the capacity of the facilities that are listed in the dashboard. The capacity can be either ‘Bales’ for bed nets or ‘Blisters’ for SMC campaigns. This will also show the out of total capacity, how much is consumed - Aggregated bales or blisters required for the villages assigned to the facility.
Assigned villages - This field will show the total number of villages that are assigned to the specific facility.
Serving population - This field will show the total population that is being served by the facility out of the total capacity of serving population of the facility. The total population that is served by the facility is the sum of the approver target population of the villages assigned. So, in case of a bednet campaign, the total serving population will be the sum of the target population of all the villages assigned to the facility, and, in case of a SMC campaign, the total serving population will be sum of the target population belonging to age group of 3 to 11 months and age group of 12 to 59 months.
Fixed post - This field tells which facilities listed in the dashboard are fixed post facilities.
Residing village - This field contains the village name where the facility resides. The user can also view the complete boundary information of the village as a tool-tip by clicking on the ‘i’ icon.
Action - Using this the user can map the facilities to their catchment areas for microplanning.
This screen shows the list of villages that are not mapped to any catchment facility.
Using this screen, the mapper will be able to map the chosen facility to their respective serviceable villages in the list. The mapper will be able to see all the villages that are part of his administrative boundaries and the villages that are not mapped to any facility.
Content of the screen -
Content of the screen -
Card showing villages with mapped facilities/POS - This card will show the count of the villages that belong to the mapper’s administrative boundary. It also shows the total number of villages (belonging to the mapper’s admin boundary) that have a catchment facility mapped.
Card showing facilities with mapped villages - This card will show the count of the facilities that belong to the mapper’s administrative boundary. It also shows the total number of facilities (belonging to the mapper’s admin boundary) that have a catchment village mapped.
Facility search - This will give the user the ability to search the specific facility that needs to be mapped to the catchment boundaries. The search needs to accept partial string match as well.
Filters - This will let the users to filter out the specific facilities that he needs to do the facility-catchment area mapping for. The user can filter out the facilities that he wants to map the catchment villages to. Below are the multi-select dropdown filters that the user will get -
a. Facility type - This will have the data of facility type defined during the instance creation
b. Facility status - This will have the facility status defined, which is either permanent or temporary
c. Is fixed post? - This will be an optional field. If the campaign distribution strategy is either ‘fixed post’ or ‘house-to-house and fixed post’, then this filter will be available for the user to choose
d. Residing village - This will have the list of all the villages that the facilities in the dashboard are part of
Facility name - This field shows the name of the facility that belongs to the user’s defined boundary.
Facility type - This field contains the type of the facilities that are listed in the dashboard.
Facility status - This field contains the status (Permanent/Temporary) of the facilities that are listed in the dashboard.
Capacity - This field contains the capacity of the facilities that are listed in the dashboard. The capacity can be either ‘Bales’ for bed nets or ‘Blisters’ for SMC campaigns.
Assigned villages - This field will show the total number of villages that are assigned to the specific facility.
Serving population - This field will show the total population that is being served by the facility out of the total capacity of serving population of the facility. The total population that is served by the facility is the sum of the approver target population of the villages assigned. So, in case of a bednet campaign, the total serving population will be the sum of the target population of all the villages assigned to the facility, and, in case of a SMC campaign, the total serving population will be sum of the target population belonging to age group of 3 to 11 months and age group of 12 to 59 months.
Fixed post - This field tells which facilities listed in the dashboard are fixed post facilities.
Residing village - This field contains the village name where the facility resides. The user can also view the complete boundary information of the village as a tool tip by clicking on the ‘i’ icon.
Action - Using this the user can map the facilities to their catchment areas for microplanning.
This screen is the landing page for the mapper. In this screen, the mapper will be able to view all the facilities/POS and their details that are part of his administrative boundaries. Important validation: For the mapper to work on mapping facility/POS to their catchment areas, the population data for the campaign must be approved by the national-level population data approver.
Content of the screen -
Card showing villages with mapped facilities/POS - This card will show the count of the villages that belong to the mapper’s administrative boundary. It also shows the total number of villages (belonging to the mapper’s admin boundary) that have a catchment facility mapped.
Card showing facilities with mapped villages - This card will show the count of the facilities that belong to the mapper’s administrative boundary. It also shows the total number of facilities (belonging to the mapper’s admin boundary) that have a catchment village mapped.
Facility search - This will give the user the ability to search the specific facility that needs to be mapped to the catchment boundaries. The search needs to accept partial string match as well.
Filters - This will let the users to filter out the specific facilities that he needs to do the facility-catchment area mapping for. The user can filter out the facilities that he wants to map the catchment villages to. Below are the multi-select dropdown filters that the user will get -
a. Facility type - This will have the data of facility type defined during the instance creation
b. Facility status - This will have the facility status defined, which is either permanent or temporary
c. Is fixed post? - This will be an optional field. If the campaign distribution strategy is either ‘fixed post’ or ‘house-to-house and fixed post’, then this filter will be available for the user to choose
d. Residing village - This will have the list of all the villages that the facilities in the dashboard are part of
Facility name - This field shows the name of the facility that belongs to the user’s defined boundary.
Facility type - This field contains the type of the facilities that are listed in the dashboard.
Facility status - This field contains the status (Permanent/Temporary) of the facilities that are listed in the dashboard.
Capacity - This field contains the capacity of the facilities that are listed in the dashboard. The capacity can be either ‘Bales’ for bed nets or ‘Blisters’ for SMC campaigns.
Assigned villages - This field will show the total number of villages that are assigned to the specific facility.
Serving population - This field will show the total population that is being served by the facility out of the total capacity of serving population of the facility. The total population that is served by the facility is the sum of the approver target population of the villages assigned. So, in case of a bednet campaign, the total serving population will be the sum of the target population of all the villages assigned to the facility, and, in case of a SMC campaign, the total serving population will be sum of the target population belonging to age group of 3 to 11 months and age group of 12 to 59 months.
Fixed post - This field tells which facilities listed in the dashboard are fixed post facilities.
Residing village - This field contains the village name where the facility resides. The user can also view the complete boundary information of the village as a tool-tip by clicking on the ‘i’ icon.
Action - Using this the user can map the facilities to their catchment areas for microplanning.
This screen shows the list of villages that are not mapped to any catchment facility.
Using this screen, the mapper will be able to map the chosen facility to their respective serviceable villages in the list. The mapper will be able to see all the villages that are part of his administrative boundaries and the villages that are not mapped to any facility.
Content of the screen -
Card with chosen facility details - This card will show the details of the facility that is chosen. This will help the mapper to understand which facility is chosen and which all villages can be mapped to it. Below are the details of the facility that will be shown -
a. Facility name
b. Facility type
c. Facility status
d. Facility capacity
e. Population being served out of the total serving population capacity of the facility
f. Is fixed post? (Optional)
g. Residing village
Boundary filter - This user will be able to filter out the boundary that is assigned to him, as well as the child boundaries. For example, if the mapper belongs to a district, then he will be able to see the filters for all the hierarchies and their boundaries at and below the assigned district. The mapper will be able to see the boundaries of the assigned district, their administrative post, their localities and their villages. All the filters will be search enabled multi-select dropdowns.
Boundary data - The user will be able to see the boundary data on his screen. Only those boundaries will be visible that are part of his assigned administrative hierarchy and lower hierarchies.
Village accessibility level button - Here the user will be able to see the village accessibility level if it was updated by the population data approver. If there is no data available for the village accessibility, then the accessibility data will be empty. Below are the details for village accessibility shown -
a. Village road condition
b. Village terrain
c. Village transport mode
Note: The data will be shown as a non-editable popup
Village security level button - Here the user will be able to see the village security level if it was updated by the population data approver. If there is no data available for the village security level, then the security level data will be empty. Below are the details for village security level shown -
a. Is your village prone to civil unrest like violent protests, riots, etc.?
b. How often do the security forces patrol the village?
Note: The data will be shown as a non-editable popup
Approved target population - Here the user will be able to see the approved target population of the village. This is for a bednet campaign.
Approved target population (Age 3 - 11 months) - Here the user will be able to see the approved target population (Age 3 - 11 months) of the village. This is for a SMC campaign.
Approved target population (Age 12 - 59 months) - Here the user will be able to see the approved target population (Age 12 - 59 months) of the village. This is for a SMC campaign.
Distance from the catchment facility (KMs) -
Here the mapper can edit and enter the distance of the facility to the catchment village. This field is optional.
Validation: The field can take only numeric values. Error message when the entered value is invalid “Please enter a numeric value”.
Assigned facility - For the ‘Unassigned villages dashboard’, none of the villages should be mapped to any catchment facility.
‘Assign to “facility name”’ button - The user will be able to see the list of the villages assigned to his administrative boundaries. The user can choose multiple villages at a time to assign them to the chosen facility. There should be a confirmation pop-up before the user approves the assignment of the facility to their catchment villages. Once confirmed, the villages will be tagged to the chosen facility for microplan.
Pop-up message - Are you sure you want to assign the selected villages to “facility name”? - There will be a Yes/No action button.
This screen will show all the villages that are assigned to the chosen facility.
Here, all the content of the dashboard will be the same as the ‘Unassigned village dashboard’, with only a difference -
In place of the ‘Assign’ button, there will be an ‘Remove from “Facility name”’ button and the mapper can choose multiple villages that he wants to unassign from the selected facility. There should be a confirmation pop-up before the user approves the unassignment of the facility to their catchment villages. Once confirmed, the villages will be untagged from the chosen facility and those villages will move to the ‘Unassigned villages dashboard’ of the chosen facility for remapping.
Pop up message - Are you sure you want to remove the selected villages from the mapped “facility name”? - There will be a Yes/No action button.
Note - The final approver of the facility assignment to the villages will be the national or highest administrative hierarchy ‘facility catchment assigner’. The national level ‘facility catchment assigner’ will have a button called ‘Finalize facility to village assignment’, and the button will only be enabled when all the villages under the campaign zone are mapped to their respective facilities/POS. Once the catchment mapping is finalized, there will be no other actions allowed on the dashboard. The user can just work with the filters to view the mapping but can’t make any changes. Once finalised, the microplan estimation should be triggered for the campaign villages.
This screen will be shown to the national level facility catchment mapper once all the campaign villages are assigned to their facilities and the assignment has been finalized by the national level facility catchment mapper.
Geospatial view -
Actor: Supervisor (Population data approver, Microplan viewer, Microplan approver, and Facility catchment mapper)
Administrative boundary: Country (Highest boundary), Province, Districts, Admin post, Locality (Second lowest boundary)
This is the flow that the user will use to visualise the microplan estimation of each village (lowest boundary) and each facility/POS.
Important validation: For the geospatial estimation view to work, it’s important that the facility-catchment area mapping is finalized for the campaign by the national-level facility catchment mapper.
Content of the screen -
Boundary filter - The user will be able to filter out the boundaries at each hierarchy and visualise the geo-cords of specific villages or facilities/POS at the chosen boundaries.
Map - Here the map can be accessed using the openstreetmap. The integration is already built so that it can be reused.
Layers - The user can view the available layers of the map using the layers capability available. The default layer will be of satellite view.
Filters - The user will be able to see two filter option on map:
a. Village filter: This will be chosen by default. This will show all the geo-coordinates of the villages (lowest boundary) on the map.
b. Facility/POS filter: This filter, if chosen, will show all the geo-coordinates of the facilities/POS on the map.
Validation: The two options will be checkboxes and a user can choose either or the options or both. By default, the village filter will be enabled.
Tool-tip information - This will show the estimate of the resources and other details for each village and facility/POS that the user chooses:
a. Village tool-tip information: The user will be able to view certain important information for the village on click -
Village name: The user will be able to see the name of the village on top.
Target population: This will show the target population of the village that will receive the bednets. This is specifically for bednet campaigns.
Target population (Age 3 - 11 months): This will show the target population of the village within the age group of 3 - 11 months that will receive the SPAQ blisters. This is specifically for the SMC campaign.
Target population (Age 12 - 59 months): This will show the target population of the village within the age group of 12 - 59 months that will receive the SPAQ blisters. This is specifically for the SMC campaign.
Total bednets: This will show the total bednets that will be required in the village for the campaign. This is specifically for bednet campaigns.
Total bales: This will show the total bednets that will be required in the village for the campaign. One bale ideally has 50 bednets in total. This is specifically for bednet campaigns.
Total SPAQ blisters (Age 3 - 11 months): This will show the total SPAQ blisters that will be required for the population within the age 3 - 11 months in the village for the campaign. This is specifically for the SMC campaign.
Total SPAQ blisters (Age 12 - 59 months): This will show the total SPAQ blisters that will be required for the population within the age 12 - 59 months in the village for the campaign. This is specifically for the SMC campaign.
Serving facilities/POS: This will show the total number of facilities/POS that serves the chosen village.
b. Facility/POS tool-tip information: The user will be able to view certain important information for the facility/POS on click -
Facility/POS name: The user will be able to see the name of the facility/POS on top.
Facility type: The user will be able to see the type of facility on the tool-tip.
Facility status: The user will be able to see the status of the facility on the tool-tip.
Capacity (Bales or SPAQ blisters): The user will be able to view the capacity of the facility on the tool-tip. For bednet campaign, the capacity will be bales and for the SMC campaign, the capacity will be SPAQ blisters.
Is fixed post?: The user will be able to see if the facility/POS a fixed post or not. This will only be shown if the resource distribution strategy for the campaign is either fixed post or mixed (fixed post & H2H).
Residing village: The user will be able to see the village at which the facility/POS resides.
Catchment villages: This will be the count of the villages (lowest boundaries) that the facility serves.
Serving population: This will be the total number of target population that the facility will serve. This is basically the sum of the total serving population of the villages that the facility is mapped to.
Serving bednets: This will be the total number of bednets that will be distributed to the villages that are mapped to the chosen facility. This is specifically for the bednet campaign.
Serving SPAQ blisters: This will be the total number of SPAQ blisters that will be distributed to the villages that are mapped to the chosen facility. This is specifically for the SMC campaign.
16. Microplan approver flow -
Actor: Supervisor (Microplan approver)
Administrative boundary: Country (Highest boundary), Province, Districts, Admin post, Locality (Second last boundary)
This is the flow for approving the microplan estimation for the boundaries that are part of the campaign. It’s an important step to make sure that the microplan estimation done by the system is correct and that the same microplan estimation can be used for campaign setup. So, the microplan estimation must be approved by the designated users at each administrative level.
Microplan approvers can act on different administrative hierarchies and depending on the hierarchy and boundaries assigned, the microplan estimation for those villages will be shown to the user for validation. For example, the Microplan approver can belong to a country, province, district, administrative post, or locality, and concerning the boundaries assigned, he will be able to see the microplan estimation for the assigned villages.
The final approver for the Microplan estimation of the country will always be the national level ‘Microplan approver’ where all the villages of the campaign zone along with their microplan estimation will be shown to the national level microplan approver.
Important validation: For the microplan approver workflow to work, it’s important that the facility-catchment area mapping is finalized for the campaign by the national-level facility catchment mapper.
This is the landing page for the ‘Microplan approver’ user where he will see the microplan estimation of the villages that are part of the administrative boundaries assigned to him. The user can check out the detailed estimation information and make changes in the microplan assumptions for the selected villages and send the changes for approval. If no changes are required in the microplan estimation, the user can directly validate the microplan estimation for the villages that are part of his assigned administrative boundaries.
Content of the landing page -
Filters on the action items on the user - This filter will help the user to filter out the villages that need some action. Below are the filters that will be shown to the user:
a. Villages with pending validation - This filter will show the list of villages whose microplan estimations are pending to be validated by the user. The user will be able to see the list of villages whose actions are pending on the user as well as on the users that belong to the child boundaries of the parent district level data approver. This filter will be further segregated as -
Pending on me - This will show the list of the villages whose microplan estimations need to be validated by the assigned user of the ‘district’. This will also show a metric - the number of villages whose microplan estimations are pending to be validated by the user. This should be by default chosen when the user lands on the page.
Pending on subordinates - This will show the list of the villages whose microplan estimations need to be validated by the users that belong to the child boundaries of the parent ‘district’. This will also show a metric - the number of villages whose microplan estimations are pending to be validated by the subordinates.
Note: A microplan approver belonging to a ‘district’ can validate the microplan estimations of the villages that belong to the child boundaries of the ‘district’, even though those villages may have their own microplan approvers assigned.
The user filtering out the villages with pending validation can perform 2 different activities -
Check and validate the microplan estimations for the villages
Change microplan assumptions for the villages and send the changes for approval to higher authorities
b. Validated villages - This filter will show the list of villages that are part of the user’s assigned boundary and whose microplan estimations have been validated either by the user himself or his subordinates at the lower administrative hierarchy level. This will also show a metric - the number of villages whose microplan estimations are validated.
The user filtering out the validated villages can perform 2 different activities -
Check and send the villages for correction if the microplan estimations are not proper
Change microplan assumptions for the villages and send the changes for approval to higher authorities
c. Villages with pending approval - This filter will show the list of villages whose microplan assumptions have been changed by the user’s subordinates at the lower administrative hierarchies. This will also show a metric - the number of villages that are pending for approval by the user.
The assigned user who can see the pending approval villages here can perform 2 activities -
Check and approve the recommended village population data
Send back the village data for correction to the user who sent the village data for approval
Dynamic boundary filters concerning parent and child administrative hierarchy - This is a dynamic filter that will be given to the user for filtering out specific boundaries. This will be a search-enabled dropdown for every filter content. The filters will be added or removed depending on the parent hierarchy assigned to the user. For example, if the user belongs to district hierarchy (Parent), then all child hierarchies and their boundaries will be part of the filter.
Additional filters - Apart from the above filters, there will be a couple of more filters that will be available to the users. The filters are -
a. Facility or point of service - This will show the list of facilities that are mapped to the villages that are part of the microplan approver’s jurisdiction.
b. Village road condition - This will show the list of road conditions that are configured and users will be able to filter out the villages with the chosen road condition.
c. Village terrain - This will show the list of terrain types that are configured and users will be able to filter out the villages with the chosen terrain types.
d. Village transport mode - This will show the list of transport modes that are configured during vehicle registration and users will be able to filter out the villages with the chosen transport mode.
e. Civil unrest occurrence - This will show the list of civil unrest occurrence frequencies configured and users will be able to filter out the villages with the chosen civil unrest occurrence frequency.
f. Security forces patrolling -This will show the list of security forces patrolling frequencies configured and users will be able to filter out the villages with the chosen security forces patrolling frequency.
Metrics to be shown - On top of the dashboard, the microplan approver will be able to see the overall metrics for the villages under his jurisdiction. The metrics are dynamic and it will change depending on the filter selected. There will be different metrics captured for different campaign types.
Metrics for Bednet campaign -
a. Target population
b. Total household
c. Bednets required
d. Bales required
Metrics for SMC campaign -
a. Target population (Age 3-11 months)
b. Target population (Age 12-59 months)
c. Total SPAQ-1 required (Age 3-11 months)
d. Total SPAQ-2 required (Age 12-59 months)
e. Total SPAQ-1 required with buffer (Age 3-11 months)
f. Total SPAQ-2 required with buffer (Age 12-59 month)
Data content for the microplan approver -
The user will be able to see all the villages that are part of the user’s jurisdiction and the microplan estimations of the villages concerning the configurations chosen by the system administrator while setting up the microplan. The fixed data points in this dashboard are -
Boundary data - The user will be able to see the boundary details of the jurisdiction that is assigned to him. For example, if the user belongs to a district, then he will be able to see the boundary data of the district, its admin posts, its localities, and finally villages along with their estimations.
Serving facility/POS - The facility is mapped to the village. This data can be fetched from the village facility catchment mapping.
Village road condition - This data can be fetched if the population data approver fills in the data for the villages assigned.
Village terrain - This data can be fetched if the population data approver fills the data for the villages assigned.
Civil unrest occurrence - This data can be fetched if the population data approver fills the data for the villages assigned.
Security forces patrolling - This data can be fetched if the population data approver fills the data for the villages assigned.
Assigned microplan approver - This will have the information of who is the assigned microplan approver for the village. This will be helpful for validating the villages that are assigned to the user’s child boundary’s microplan approver (subordinates).
Total population - This is the total population of the village that is approved by the country level population data approver.
Target population - This is the target population of the village that is approved by the country level population data approver. This is for a bednet campaign.
Target population (Age 3-11 months) - This is the target population (Age 3-11 months) of the village that is approved by the country level population data approver. This is for a SMC campaign.
Target population (Age 12-59 months) - This is the target population (Age 12-59 months) of the village that is approved by the country level population data approver. This is for a SMC campaign.
View comment logs - The user will be able to see the comment logs for every action taken on the village using the comment logs button that will be available corresponding to each village.
View change logs - The user will be able to see the changes done in the microplan estimations of the villages once the microplan assumptions are updated.
Rest of the data points will be flexible and depending on the configuration chosen by the system admin, those estimation data points will be shown in this dashboard.
Action on the villages - There will be certain actions that the user can take on the villages depending on the filter chosen. The actions are -
1. Validate - This action will be available for the filters chosen ‘Villages with pending validation’. More details will be provided below.
Send back for correction - This action will be available for the filters chosen ‘Villages with pending approval’ and ‘Validated villages’. More details will be provided below.
Approve - This action will be available for the filters chosen ‘Villages with pending approval’. More details will be provided below.
Customise assumptions - This action will be available for the filters chosen ‘Validated villages’ and ‘Villages with pending validation’. More details will be provided below.
Workflow diagram for microplan approver -
Workflow for validating village microplan estimation -
This workflow will let the user validate the microplan estimations for the villages that are under the user’s jurisdiction. This workflow will be a part of the ‘Villages with pending validation’ bucket where the user can multiple villages at once and then validate the villages in bulk if the village microplan estimations seem correct to the user. Once the selected villages are validated, the validated villages will move from the ‘Villages with pending validation’ bucket of the user to the ‘Validated villages’ bucket of the user. Other users who have access to the same jurisdiction will be able to see the validated villages in the ‘Validated villages’ bucket. It’s important that the user adds a comment/reason for validating the microplan estimation of the assigned villages. Any higher authority user will be able to check out the comment logs from the dashboard. Attaching the comment box UI below:
Workflow for customisation of microplan assumptions -
When the villages are available in the ‘Villages with pending validation’ and ‘Validated villages’ buckets, the microplan approver will be able to choose one or more villages to customize their microplan assumptions as per requirement. The microplan approver will be able to see the list of all villages that are under the microplan approver’s jurisdiction.
Once the user clicks on the ‘Customise assumptions’ button, the microplan approver will be redirected to a screen where the user can play around with the microplan assumptions unless the desired microplan estimation for the chosen villages is achieved.
When the microplan approver chooses the village to customize their microplan assumptions, the user will be able to see the standard or already configured assumption value. The user can change and update the microplan assumption value and see the outcome of the changes in the microplan estimation dashboard by clicking on the ‘Apply’ button.
Once the microplan estimations are updated and finalized, the microplan approver can click on the ‘Confirm customisation’ button to go ahead with the estimation changes for the selected villages.
Upon clicking the ‘Confirm customisation’, the user will be shown a pop-up showing which all assumptions are being changed and what was their old value and what is their updated value. The old value will be the standard assumption value if the user is changing the microplan assumption for the village for the first time, if the user is changing the microplan assumption for a village for second/third/so on times, then the old value of the microplan assumption will be last saved value of the microplan assumption. For example, for a village, one of the assumptions was changed from 10 to 20 and then saved by a user. Then, for the same village, the same assumption is changed from 20 to 40, so upon confirmation, the user should be able to see the old value as 20 and the new value as 40.
For sending the changes for approval, the microplan approver needs to add a comment/reason. Below is the UI for adding comments before sending the changes for approval:
Workflow for approving the village microplan estimation -
If the supervisor microplan approver feels that the recommended changes in the village estimations are correct, then the microplan approver will approve the village’s microplan estimation using the ‘Approve’ button (The user can choose multiple villages for approval at once). Upon approving the updated microplan estimation for the villages, the villages will be moved from the assigned microplan approver’s ‘Villages with pending approval’ bucket to the next higher administrative hierarchy microplan approver’s ‘Villages with pending approval’ bucket. This workflow will go on until the national or highest administrative hierarchy level microplan approver approves the microplan estimation changes for the villages. Once the changes reach the highest administrative hierarchy for approval and the national level microplan approver approves the updated microplan estimation changes, the village status will be ‘Validated’ and the village will reside in the ‘Validated villages’ bucket. For every approval, the microplan approver needs to add a reason as a comment and that comment will be seen in the comment logs.
Note: The microplan approver will be able to see and take actions on the pending approvals on him as well as the pending approvals on his subordinates.
Comment box UI:
Workflow for sending back the village microplan estimation for correction -
This workflow will be available in the ‘Villages with pending approval’ and ‘Validated villages’ bucket of the dashboard.
When the villages are available in the ‘Validated villages’ bucket and the microplan approver feels that the microplan estimation for some of the villages are incorrect or needs correction, the microplan approver can choose those villages and send them back for correction using the ‘Send back for correction’ button. The villages that are sent back for correction by the microplan approver will move from the ‘Validated villages’ bucket to the ‘Villages with pending validation’ bucket of the user, who first validated the microplan estimation of the villages.
When the villages are available in the ‘Villages with pending approval’ bucket and the microplan approver feels that the changed/updated microplan estimation for some of the villages need correction, then the microplan approver chooses those villages and sends them back for correction using the ‘Send back for correction’ button. The villages that are sent back for correction by the microplan approver will move from the ‘Villages with pending approval’ bucket to the ‘Villages with pending validation’ bucket of the user, who first made changes in the microplan assumptions and submitted the data for approval to the higher jurisdiction microplan approver.
It is important that every time the user sends back the data for correction, he needs to add a comment/reason for his action. Attaching the comment box UI below:
View comment logs for villages -
The user can see the comment logs by clicking on the comment logs link. The user will be able to see the detailed action taken on a village along with the timestamp and comment details. This will help the supervisors to understand what actions have been taken in a village and who took the action. This will help in keeping traceability of the changes happening to a village. The button to check the comment logs will be available corresponding to each village in the dashboard.
The content of the comment logs are -
Status of the action - The user will be able to see the status of the actions taken by the other users. For every action, the status will be captured w.r.t the village and updated in the comment logs. There will be 4 status on a high level:
a. Sent for approval - Once the microplan assumptions have been changed for one or more villages by a user and forwarded for approval, the status will be changed to ‘Sent for approval’.
b. Approved - Once the user approves the recommended microplan assumption changes for the villages, it moves to ‘Approved’ status.
c. Validated - Once the microplan estimations for the villages have been validated by the user or by the highest jurisdiction level microplan approver, the status will be changed to ‘Validated’ and the village will be moved to ‘Validated villages’ bucket.
d. Sent for correction - Once the microplan estimations for the villages have been checked by the supervisor and supervisors decide to send the village data for correction, the status will be changed to ‘Sent for correction’.
User’s name and role - Whenever a user takes an action on the village and puts a comment, for every action, the user’s name and role will be captured and shown in the comment logs.
Timestamp - Whenever a user takes an action on the village and puts a comment, for every action, the timestamp of the action will be captured. It should be in the international timestamp format “YYYY-MM-DD HH:MM”.
Comment - Whenever a user takes an action on the village and puts a comment, it will be captured alongside the other details.
View microplan estimation change logs for villages -
If a village goes through multiple changes in the assumptions, and as a result of which the microplan estimations for the village changes multiple times, all these changes in the microplan estimations need to be captured in the change logs for the village. The button to check the change logs will be available corresponding to each village in the dashboard. Below are the information that will be shown on the change logs pop-up -
Which microplan estimation data points changed? The user should be able to see the microplan estimation data points that have been changed after updating the microplan assumptions.
Who updated the microplan assumptions? The user should be able to see who has updated the microplan assumptions as a result of which the microplan estimations got changed for the village.
Timestamp of the changes -The user should be able to see at what time the microplan assumptions were changed. It should be in the international timestamp format “YYYY-MM-DD HH:MM”.
What’s the change in the microplan estimations? The user should be able to see what was the earlier value of the microplan estimation data point vs the updated value of the microplan estimation data point.
Note on microplan estimation for the villages -
It’s crucial that for doing the human resource microplan estimation, every village needs to have the assigned facility mapped. Depending on the type of facility (fixed post or non-fixed post), the system will calculate the human resource estimations accordingly. But, it shouldn’t affect the medical resource estimation for the village, such as, number of bednets or SPAQ required for the village shouldn’t be dependent on the facility mapped to the village.
Use-case to cover: What if the country-level microplan approver customizes the microplan assumptions?
The country-level microplan approver can change microplan assumption for any village under his jurisdiction. Now, since the country-level microplan approver doesn’t have any superior role assigned above him, the changes will not go through any approval process. The country-level microplan approver can simply make the changes, add a reason for the changes, and save the changes. The status of the village will remain unchanged but all the changes should be logged in the comment and change logs.
Note - The final approver of the microplan estimation for the campaign villages will be the national or highest administrative hierarchy ‘Microplan approver’. The national level ‘Microplan approver’ will have a button called ‘Finalize microplan’ (Irrespective of any filters), and the button will only be enabled when the ‘Villages with pending validation’ is 0, ‘Villages with pending approval’ is 0 and ‘Validated villages’ is x/x, that is, if there are 500 villages in the campaign zone, then 500 villages should be in the validated status. Once the microplan estimation data is finalized, there will be no action allowed on the dashboard. The user can just work with the filters to view the data but can’t make any changes. Once the microplan estimates are finalised, the user can download the Excel for the microplan estimates from the home page.
This is the final screen that the country-level microplan approver will be able to see once the microplan is finalised. The user can either download the microplan estimation as an Excel or go to the admin console to set up the campaign for the microplan.
Microplan viewer flow -
Actor: Supervisor (Microplan viewer)
Administrative boundary: Country (Highest boundary), Province, Districts, Admin post, Locality (Second last boundary)
This is the flow for viewing the microplan estimation for the boundaries that are part of the campaign. It’s an important step to make sure that the microplan estimation done by the system is correct and that the same microplan estimation can be used for campaign setup. So, the microplan estimation must be viewed/reviewed by the designated users at each administrative level.
Microplan viewers can act on different administrative hierarchies and depending on the hierarchy and boundaries assigned, the microplan estimation for those villages will be shown to the user. For example, the Microplan viewer can belong to a country, province, district, administrative post, or locality, and concerning the boundaries assigned, he/she can see the microplan estimation for the assigned villages.
Validation: For the microplan viewer workflow to work, it’s important that the facility-catchment area mapping is finalized for the campaign by the national-level facility catchment mapper.
This is the landing page for the ‘Microplan viewer’ user where he will see the microplan estimation of the villages that are part of the administrative boundaries assigned to him. Here, the user will only be able to see the villages that have been validated by the assigned microplan approver.
Content of the landing page -
Dynamic boundary filters with respect to parent and child administrative hierarchy - This is a dynamic filter that will be given to the user for filtering out specific boundaries. This will be a search-enabled dropdown for every filter content. The filters will be added or removed depending on the parent hierarchy assigned to the user. For example, if the user belongs to district hierarchy (Parent), then all child hierarchies and their boundaries will be part of the filter.
Additional filters - Apart from the above filters, there will be a couple of more filters that will be available to the users. The filters are -
- Facility or point of service - This will show the list of facilities that are mapped to the villages that are part of the microplan approver’s jurisdiction.
- Village road condition - This will show the list of road conditions that are configured and users will be able to filter out the villages with the chosen road condition.
- Village terrain - This will show the list of terrain types that are configured and users will be able to filter out the villages with the chosen terrain types.
- Village transport mode - This will show the list of transport modes that are configured during vehicle registration and users will be able to filter out the villages with the chosen transport mode.
- Civil unrest occurrence - This will show the list of civil unrest occurrence frequencies configured and users will be able to filter out the villages with the chosen civil unrest occurrence frequency.
- Security forces patrolling -This will show the list of security forces patrolling frequencies configured and users will be able to filter out the villages with the chosen security forces patrolling frequency.
Metrics to be shown - On top of the dashboard, the micro plan viewer will be able to see the overall metrics for the villages under his jurisdiction. The metrics are dynamic, and they will change depending on the filter selected. Different metrics will be captured for different campaign types.
Metrics for Bednet campaign -
- Target population
- Total household
- Bednets required
- Bales required
Metrics for SMC campaign -
- Target population (Age 3-11 months)
- Target population (Age 12-59 months)
- Total SPAQ-1 required (Age 3-11 months)
- Total SPAQ-2 required (Age 12-59 months)
- Total SPAQ-1 required with buffer (Age 3-11 months)
- Total SPAQ-2 required with buffer (Age 12-59 month)
Data content for the microplan viewer -
The user will be able to see all the villages that are part of the user’s jurisdiction and the microplan estimations of the villages concerning the configurations chosen by the system administrator while setting up the microplan. The fixed data points in this dashboard are -
Boundary data - The user will be able to see the boundary details of the jurisdiction that is assigned to him. For example, if the user belongs to a district, then he will be able to see the boundary data of the district, its admin posts, its localities and finally villages along with their estimations.
Serving facility/POS - The facility is mapped to the village. This data can be fetched from the village facility catchment mapping.
Village road condition - This data can be fetched if the population data approver fills the data for the villages assigned.
Village terrain - This data can be fetched if the population data approver fills the data for the villages assigned.
Civil unrest occurrence - This data can be fetched if the population data approver fills the data for the villages assigned.
Security forces patrolling - This data can be fetched if the population data approver fills the data for the villages assigned.
Assigned microplan approver - This will have the information of who is the assigned microplan approver for the village. This will be helpful for validating the villages that are assigned to the user’s child boundary’s microplan approver (subordinates).
Total population - This is the total population of the village that is approved by the country level population data approver.
Target population - This is the target population of the village that is approved by the country level population data approver. This is for a bednet campaign.
Target population (Age 3-11 months) - This is the target population (Age 3-11 months) of the village that is approved by the country level population data approver. This is for a SMC campaign.
Target population (Age 12-59 months) - This is the target population (Age 12-59 months) of the village that is approved by the country level population data approver. This is for a SMC campaign.
View comment logs - The user will be able to see the comment logs for every action taken on the village using the comment logs button that will be available corresponding to each village.
View change logs - The user will be able to see the changes done in the microplan estimations of the villages once the microplan assumptions are updated.
Rest of the data points will be flexible and depending on the configuration chosen by the system admin, those estimation data points will be shown in this dashboard.
It is critical for the program team to set up the campaign as per the microplan created. And in order to do that, the admin console, which sets up the campaign, needs to map the correct microplan for campaign creation. As part of the integration, the Microplanning platform will share the below details with the admin console for campaign setup:
Microplan name
Campaign details
Facility data
Administrative boundaries and their targets
Number of human resources required as per the campaign distribution strategy chosen
a. Number of fixed post registration members required and boundary
b. Number of fixes post distribution members required and boundary
c. Number of household registration members required and boundary
d. Number of household distribution members required and boundary
e. Number of fixed post registration supervisors required and boundary
f. Number of fixed post distribution supervisors required and boundary
g. Number of household registration supervisors required and boundary
h. Number of household distribution supervisors required and boundary
i. Number of household registration monitors required and boundary
j. Number of household distribution monitors required and boundary
The admin console needs to provide the program team with a screen to choose the microplan for which the campaign needs to be set up.
User adoption and engagement -
- User Registration: The number of microplan users registered on the platform.
- Session Time: The average amount of time users spend on the platform in minutes.
- Population coverage accuracy - The total population considered in the microplan vs the total population captured during the campaign execution.
- Resource utilization accuracy - The total number of resources (bednets, frontline workers, vehicles, etc.) estimated during the microplanning phase versus a total number of resources utilised during campaign execution.
- Operational efficiency - Time required to finalise a microplan from the created time.
- Microplan adoption - The number of microplans created w.r.t countries.
- Reusability of Microplans: The frequency with which previous microplans are reused or adapted for new campaigns.
System specs & validation for Microplan module v0.1 -
The Data Approver is responsible for validating population data collected by data collectors. The role primarily ensures that population data used for microplan resource estimation is accurate and consistent with predefined rules. Data approvers play a crucial role in identifying discrepancies and ensuring the validity of population numbers before final approval.
Validate population data collected from the field.
Identify discrepancies in population estimates.
Approve or flag data for further review and corrections.
Note : In the current version we are not including data collectors. Population data uploaded in the system admin flow will be sent for approval
The following describes the step-by-step workflow for the Data Approver:
Step 1: Log in to the Platform
Actor: Data Approver
Objective: Access the data review dashboard.
Process: The Data Approver logs into the microplanning platform with their credentials.
Outcome: The system displays all pending data that needs to be validated.
Step 2: Review Submitted Population Data
Actor: Data Approver
Objective: View population data collected by Data Collectors.
Process:
The Data Approver navigates to the population data review section.
The system presents the population data per administrative level (village, district, etc.).
Data is compared against previously uploaded data or other authoritative sources for discrepancies.
Outcome: The Data Approver views all population-related information for selected regions, including:
Total Population
Target Population (e.g., children aged 3-11 months and 12-59 months for SMC campaigns)
Latitude and Longitude (if available)
Step 3: Identify Discrepancies
Actor: Data Approver
Objective: Identify and highlight any discrepancies in the population data.
Process:
The Data Approver can manually review records to ensure the accuracy of the data.
Outcome: The system flags any discrepancies for further review, such as:
Significant deviations from earlier data (e.g., a village's population is reported as 5,000 when the previous figure was 2,000).
Step 4: Modify and Correct Data (If necessary)
Actor: Data Approver
Objective: Make necessary corrections to flagged data before approval.
Process:
If the Data Approver identifies errors or discrepancies, they may either:
Request corrections from the Data Collector.
Manually correct the data in the system, if they have the necessary authority and information.
Corrections may involve:
Adjusting total population numbers.
Updating target population estimates.
Correcting missing or incorrect geographic data (e.g., coordinates).
Outcome: The flagged data is corrected and updated in the system, ready for re-validation.
Step 5: Approve Population Data
Actor: Data Approver
Objective: Final approval of population data for use in resource estimation.
Process:
Once all discrepancies are resolved, the Data Approver selects the data records for final approval.
The system allows bulk approval or individual record validation based on user preferences.
Outcome: Approved population data is locked and made available for further processes, such as microplan resource estimation.
Step 6: Monitor Data Changes
Actor: Data Approver
Objective: Continuously monitor any changes to population data during the campaign.
Process:
The system provides alerts if any new data is submitted or if there are significant changes to previously approved data.
Data Approvers can review and re-approve any updates or revisions during the campaign.
Outcome: All data changes are tracked, ensuring continuous data integrity throughout the microplanning process.
The Facility Catchment Mapper is responsible for mapping health facilities to their respective geographic catchment areas (e.g., villages, districts) using data provided via an API. This mapping ensures that each facility is associated with a specific community, enabling efficient distribution of resources during health campaigns.
Assign health facilities to geographic catchment areas (e.g., villages, localities).
Ensure each village or locality is mapped to an appropriate facility.
Review and update facility assignments when necessary based on campaign requirements.
Below are the detailed steps for the facility catchment mapping process.
Step 1: Log in to the Platform
Actor: Facility Catchment Mapper
Objective: Access the facility catchment management dashboard.
Process: The Facility Catchment Mapper logs into the microplanning platform using their credentials and navigates to the facility catchment module.
Outcome: The system displays a list of available campaigns and their linked facilities retrieved from the API.
Step 2: View Facility Data via Plan Facility
Actor: Facility Catchment Mapper
Objective: Access the list of facilities linked to the microplan, pulled from the Plan Facility.
Process:
The system retrieves the list of facilities linked to the current campaign and displays them in the catchment mapping dashboard.
The data from the Plan Facility includes key attributes such as:
Facility Name
Facility Type (e.g., clinic, hospital)
Capacity (e.g., beds, vaccine storage)
Facility Status (active/inactive)
Facility Location (latitude and longitude)
Outcome: The Facility Catchment Mapper can view all the facilities available for mapping in real time.
Step 3: Assign Facilities to Catchment Areas
Actor: Facility Catchment Mapper
Objective: Map each facility to a corresponding catchment area (e.g., village, district).
Process:
Catchment Area Mapping:
Each facility is mapped to a specific administrative boundary (village, district, etc.).
Facility location (latitude and longitude) is used to cross-reference and ensure the correct geographic catchment area is assigned.
Mapping Considerations:
Ensure each catchment area is assigned to the most appropriate or nearest facility based on geographic proximity.
Avoid conflicts where multiple facilities are mapped to the same geographic area, unless required by the campaign.
Outcome: Each facility is successfully assigned to its respective catchment area, ensuring proper resource allocation during campaign execution.
Step 4: Validate Catchment Area Assignments
Actor: Facility Catchment Mapper
Objective: Ensure the accuracy and validity of facility assignments to catchment areas.
Process:
The system highlights any potential mapping errors or overlaps, such as:
Unmapped villages or localities.
Facilities assigned to incorrect or multiple areas.
The Facility Catchment Mapper reviews and resolves these issues before finalizing the assignments.
Validation checks include:
Ensure each village or locality is mapped to exactly one facility.
Verify that all mandatory fields (facility name, type, status, location) are populated.
Outcome: The mapping is validated, and all errors are corrected before approval.
Step 5: Approve and Save Facility Catchment Mapping
Actor: Facility Catchment Mapper
Objective: Finalize and approve the facility catchment mapping.
Process:
Once all assignments are validated, the mapper approves the mappings.
The system saves the approved mappings, and the data is made available for use in microplan resource estimation and campaign execution.
Outcome: Facility catchment mapping is finalized and stored in the system, ensuring proper facility allocation for the upcoming health campaign.
Geographical Accuracy:
Facilities must be assigned to the correct administrative boundaries based on their geographic coordinates.
Avoiding Overlap:
Each catchment area (village, locality, etc.) should be mapped to only one facility unless otherwise required by the campaign's objectives.
Handling Missing Facilities:
If a catchment area does not have a mapped facility, it must be flagged for review and resolution before the campaign begins.
Create/Update Microplan
The System Administrator is responsible for setting up the entire microplanning platform, which includes defining campaign boundaries, configuring facilities, and assigning roles. This user operates at the national or country level and ensures all configurations align with campaign objectives.
Capture Campaign Details:
Actor: System Administrator/Program Manager
Objective: Configure campaign information.
Process:
Select Disease: Choose the disease for the campaign (e.g., malaria).
Campaign Type: Select from options like Bednets or SMC (Seasonal Malaria Chemoprevention).
Resource Distribution Strategy: Choose between Fixed post, House-to-House, or a combination of both.
Next/Back: Proceed to the next screen or return to the previous step.
Validation:
All fields are mandatory before proceeding.
Naming the Microplan:
Actor: System Administrator/Program Manager
Objective: Assign a unique name to the microplan.
Process:
Auto-Suggested Name: The system provides a default name based on the format: Country-Disease-CampaignType-MonthLast2DigitsOfYear
.
User Input: Option to modify the name while following a strict naming convention.
Validation:
The name must be unique and follow specific guidelines (e.g., minimum 3 characters, no special characters except _() ).
Select Campaign Boundaries:
Actor: System Administrator/Program Manager
Objective: Choose the geographic administrative boundaries (country, province, district, village, etc.).
Process:
Multi-Select Dropdowns: Select from a multi-select list of administrative divisions.
Validation: All fields are mandatory.
Upload Population Data:
Actor: System Administrator/Program Manager
Objective: Upload population data required for resource estimation.
Process:
Download Template: Download a pre-configured Excel template.
Input Data: Enter total and target population, village coordinates, etc.
Upload: After filling in the template, upload it back to the system.
Validation:
Ensure data integrity (e.g., total population must be greater than zero, population data must be whole numbers).
Upload Facility Data:
Actor: System Administrator/Program Manager
Objective: Set up facilities to be used during the campaign.
Process:
Download Facility Template: Fill out the downloaded template with facility details (e.g., facility type, capacity, geographic coordinates).
Upload and Validate: Once filled, upload the template.
Validation:
Mandatory fields such as facility name, type, and capacity must be filled in.
Manage Microplan Assumptions:
Actor: System Administrator/Program Manager
Objective: Configure assumptions for calculating required resources.
Process:
Set parameters like population density and distribution strategy.
Validation:
Input values must be numerical.
Access Control and Role Configuration:
Actor: System Administrator
Objective: Define and assign roles and permissions (e.g., Data Collectors, Microplan Approvers).
Process:
Configure roles and assign them to specific users.
Define user boundaries and access hierarchies.
The Microplan Estimation Approver plays a critical role in ensuring the accuracy and approval of resource estimation for health campaigns. This user is responsible for reviewing the resource estimations generated by the system, validating assumptions, and approving or rejecting the final microplan estimations. The goal is to ensure that the estimated resources (e.g., vaccines, bednets, medical personnel) align with the actual needs of the campaign, based on the validated population and facility data.
Review and validate resource estimation formulas.
Approve or reject microplan resource estimations.
Adjust estimation parameters and assumptions if necessary.
Ensure that the approved resource estimation aligns with the campaign's needs.
This section details the steps in the microplan estimation approval process.
Step 1: Log in to the Platform
Actor: Microplan Estimation Approver
Objective: Access the microplan estimation dashboard.
Process: The microplan Estimation Approver logs into the platform using their credentials, granting access to the estimation review and approval module.
Outcome: The system displays a list of microplans that require review, with detailed estimations ready for approval.
Step 2: Review Resource Estimation
Actor: Microplan Estimation Approver
Objective: Review the resource estimations generated by the system for the current campaign.
Process:
The system presents the resource estimation calculations based on the uploaded population and facility data.
The estimations are divided into key resources such as:
Vaccines: Estimated based on population size and target population.
Bednets: Calculated for campaigns like malaria prevention.
Personnel: Estimated based on the required workforce for each facility and catchment area.
Outcome: The microplan estimation approver has a comprehensive overview of the resources estimated for the campaign, with breakdowns by resource type.
Step 3: Review and Validate Assumptions
Actor: Microplan Estimation Approver
Objective: Ensure that the assumptions used for resource estimations are accurate and reasonable.
Process:
The system displays key assumptions that drive the resource estimation formulas, such as:
Target Population: Number of people eligible for the intervention (e.g., children aged 3-11 months for SMC campaigns).
Resource Allocation: Number of resources (e.g., bednets, vaccines) per person or household.
Distribution Strategy: House-to-house, fixed post, or a combination of both.
The approver cross-checks these assumptions with known data and campaign requirements.
If any assumptions seem inaccurate or unreasonable, the Microplan Estimation Approver can modify assumptions for list of specific boundaries
Outcome: The assumptions used for resource estimation are validated, and any necessary corrections are made.
Step 4: Approve or Reject the Microplan Estimation
Actor: Microplan Estimation Approver
Objective: Make the final decision to approve or reject the resource estimation for the campaign.
Process:
After reviewing the resource estimation, the Microplan Estimation Approver selects Approve or Reject.
Approve: Confirms that the estimation is valid and the required resources are accurately calculated. Once approved, the estimation becomes final and is locked for campaign execution.
Reject: If the estimation is inaccurate, the approver provides feedback and requests a re-evaluation of the data or assumptions.
The system prompts the approver to provide reasons for rejection, which are communicated to the appropriate team for corrections.
Outcome: Once approved, the resource estimation is finalized, and the required resources are allocated for the campaign. If rejected, the estimation returns to the appropriate team for review and modification.
Plan Management - Handles micro plan setup, micro plan employee assignments, micro plan facility linkage, micro plan estimations and its validation/approval.
Census Management - Handles population data and its validation/approval.
Resource Generator - Utility service which reads population and facility excel files uploaded by the user to generate population records and plan facility linkages in the system.
Project Factory - Utility service which exposes APIs to generate population data upload template and facility data upload template.
Plan management service handles micro plan setup, micro plan employee assignments, micro plan facility linkage, micro plan estimations and its validation/approval.
Plan Management API Specification
Census management service handles population data and its validation/approval.
Census Management API Specification
The HCM Microplan Web platform is designed to be easy to use, giving administrators and supervisors simple access to the tools they need for setting up microplans, managing data. The navigation is divided into two main sections: Set Up Microplan and Supervisor Flow.
This section is intended for system administrators and users responsible for the initial setup of the microplan, configuration, and data management. The available options under this section include:
Configuration of the fundamental details of the microplan, including objectives, timelines, and other key parameters.
Define and select the geographical boundaries (countries, provinces, districts, etc.) relevant for the microplan.
Manage the population data and other datasets needed for the microplan, including data entry, updates, and validation.
Specify the assumptions that will guide the microplan, including factors like updated registry data, user roles, and collection methodology.
Set up formulas and calculations used for resource distribution, target population estimates, or other metrics within the microplan.
: The User Tagging Screen enables the Microplan admin to assign various roles to registered users, linking them to specific tasks and responsibilities within the microplan.
: The Summary Screen is a critical page in the microplan setup process, where system administrators and program managers can review, validate, and edit the data configured for the microplan. It provides.
This section allows administrators to manage users, assign roles, and control access levels for those interacting with the system. This ensures the security and integrity of the platform, with specific permissions for different types of users (e.g., system administrators, data collectors, reviewers).
This section is tailored to supervisors who oversee the implementation and validation of the microplan. Key functionalities under this flow include:
Product showcase done on 16-DEC-2024 by
Click to view the actor-noun-verb mapping.
Click to view the detailed roadmap and value bundle
Click to view in Miro board
The template for bednets is .
The template for SMC is .
The template for the facility is
The template for bulk upload users is
There should be proper regex validation on the emila ID entered. The system should only accept the email ID that matches with the email format such as ‘’. If the entered email ID doesn’t match the proper email structure, then show error message ‘The ‘email ID’ entered is invalid, please update and re-upload’.
Find the system specification
A personalized dashboard where supervisors can view and manage the microplan assigned to them.
Choose specific activities related to the microplan that need to be validated or reviewed.
Validate the collected population data and approve it for further processing and execution of the health campaign.
Assign health facilities to specific villages or regions, ensuring resources and health services are properly allocated.
Role
User mapped?
Administrative hierarchy
Administrative areas assigned?
Warning message
Action on warning
Microplan estimation approver
No
-
-
There is no ‘Microplan estimation approver’ assigned to the microplan. Are you sure to continue without assigning ‘Microplan estimation approver’?
Choice A (Highlighted button) - No, I don’t want to continue
Choice B - Yes, I want to continue
Microplan estimation approver
Yes
Province/district/Admin post/Locality
All province/district/Admin post/Locality
Microplan estimation approver
Yes
Province/district/Admin post/Locality
Some province/district/Admin post/Locality
‘Microplan estimation approver' role is assigned to only a few 'province/district/Admin post/Locality', would you like to proceed without assigning 'Microplan estimation approver' role to remaining 'province/district/Admin post/Locality'?
Choice A (Highlighted button) - No, I don’t want to proceed
Choice B - Yes, I want to proceed
Role
User mapped?
Administrative hierarchy
Administrative areas assigned
Warning message
Action on warning
Microplan estimation viewer
No
-
-
There is no ‘Microplan estimation viewer’ assigned to the microplan. Are you sure to continue without assigning ‘Microplan estimation viewer’?
Choice A (Highlighted button) - No, I don’t want to continue
Choice B - Yes, I want to continue
Microplan estimation viewer
Yes
Province/district/Admin post/Locality
All province/district/Admin post/Locality
Microplan estimation viewer
Yes
Province/district/Admin post/Locality
Some province/district/Admin post/Locality
‘Microplan estimation viewer' role is assigned to only a few 'province/district/Admin post/Locality', would you like to proceed without assigning 'Microplan estimation viewer' role to remaining 'province/district/Admin post/Locality'?
Choice A (Highlighted button) - No, I don’t want to proceed
Choice B - Yes, I want to proceed
Role
User mapped?
Administrative hierarchy
Administrative areas assigned
Warning message
Action on warning
Facility catchment assigner
No
-
-
There is no ‘Facility catchment assigner’ assigned to the microplan. Are you sure to continue without assigning ‘Facility catchment assigner’?
Choice A (Highlighted button) - No, I don’t want to continue
Choice B - Yes, I want to continue
Facility catchment assigner
Yes
Province/district/Admin post/Locality
All province/district/Admin post/Locality
Facility catchment assigner
Yes
Province/district/Admin post/Locality
Some province/district/Admin post/Locality
‘Facility catchment assigner' role is assigned to only a few 'province/district/Admin post/Locality', would you like to proceed without assigning 'Facility catchment assigner' role to remaining 'province/district/Admin post/Locality'?
Choice A (Highlighted button) - No, I don’t want to proceed
Choice B - Yes, I want to proceed
Role
User mapped?
Administrative hierarchy
Administrative areas assigned
Warning message
Action on warning
Population data approver
No
-
-
There is no ‘Population data approver’ assigned to the microplan. Are you sure to continue without assigning ‘Population data approver’?
Choice A (Highlighted button) - No, I don’t want to continue
Choice B - Yes, I want to continue
Population data approver
Yes
Province/district/Admin post/Locality
All province/district/Admin post/Locality
Population data approver
Yes
Province/district/Admin post/Locality
Some province/district/Admin post/Locality
‘Population data approver' role is assigned to only a few 'province/district/Admin post/Locality', would you like to proceed without assigning 'Population data approver' role to remaining 'province/district/Admin post/Locality'?
Choice A (Highlighted button) - No, I don’t want to proceed
Choice B - Yes, I want to proceed
Here are the articles in the section:
The Data Management step includes two substeps: Population Upload and Facility Upload, enabling users to upload essential data for the microplan.
Description: This substep allows users to upload population data for the campaign.
Download Template: Download the template for population data.
Boundary Dependency: The boundaries appearing in the population template are dependent on the boundaries selected in the previous Boundary Selection screen. Tabs in the template will correspond to the districts selected in that screen.
File Upload: Drag and drop or browse to upload the filled Excel file.
Guidelines:
Mandatory Fields: The Total Population and Target Population columns are mandatory and must be provided as whole numbers.
Latitude & Longitude: These fields must be in Degree Decimal or Degree Minute Seconds format.
Description: This substep allows users to upload facility or point-of-service information.
Download Template: Download the template for facility data.
Boundary Codes: The facility template will include boundary codes for the villages selected in the previous Boundary Selection screen in a single Boundary Code sheet.
File Upload: Drag and drop or browse to upload the filled Excel file.
Guidelines:
All fields are mandatory except for Latitude and Longitude.
Latitude & Longitude must be in Degree Decimal or Degree Minute Seconds format.
Validation Process: After the file is uploaded, the system will validate the data. If any errors are found, the system will populate an Error column in the sheet, showing the errors next to the corresponding rows.
Error Preview: Clicking the View Error button will show a preview of the uploaded Excel file, highlighting the errors in the Error column next to the corresponding row.
Re-upload Process: Once the errors are corrected, users can download the validated file, make the necessary changes, and re-upload the file.
Proceeding with Valid Data: Processing will only proceed if a valid sheet with no errors is uploaded. If the sheet is valid, the system will continue to the next step.
Warning: If the user navigates back to the Boundary Selection screen, the current uploaded templates for Population and Facility will be discarded. A warning message will appear on the UI to inform the user before they proceed.
Both the generation and validation of facility and boundary data are based on a schema provided by MDMS.
Generation: From this schema, fields are converted into columns in the respective upload templates.
Validation: Validation is performed based on the schema, ensuring that the data adheres to the defined structure.
Additionally, custom validations are applied to ensure data integrity.
Localization: All labels, instructions, and error messages are translatable into multiple languages.
File Upload: The interface supports drag-and-drop or browse-to-upload file options.
Validation: Validation ensures all required fields are completed and data is properly formatted. Processing will proceed only if a valid sheet with no errors is uploaded.
Here is the updated table with the adjustments:
/project-factory/v1/project-type/search
POST
{ "tenantId": "mz", "ids": [ "2a2491a7" ], "pagination": {}, "RequestInfo": {} }
/plan-service/config/_search
POST
{ "PlanConfigurationSearchCriteria": { "tenantId": "mz", "id": "660fb389-5e60-4c43-b6ce-b1c109b23f54" } ,"RequestInfo": {} }
/project-factory/v1/data/_create
POST
{ "ResourceDetails": { "type": "boundaryWithTarget", "hierarchyType": "MICROPLAN", "tenantId": "mz", "fileStoreId": "29e31558-24ce-4efb-8102-cfa92961efdd", "action": "validate", "campaignId": "8c413d61-c411-4c33-b6eb-76ea005a84c9", "additionalDetails": { "source": "microplan" } }, "RequestInfo": {} }
/project-factory/v1/data/_search
POST
{ "SearchCriteria": { "id": ["08bb247d-364a-4b44-b0a9-d8efeee5a6a4"], "tenantId": "mz", "type": "boundaryWithTarget" }, "RequestInfo": {} }
/project-factory/v1/project-type/update
POST
{ "CampaignDetails":{"id":"8c413d61-c411-4c33-b6eb-76ea005a84c9","tenantId":"mz","status":"drafted","action":"draft","campaignNumber":"CMP-2024-12-03-006616","isActive":true,"parentId":null,"campaignName":"Malaria-Bednet Campaign-Fixed Popp0099","projectType":"LLIN-mz","hierarchyType":"MICROPLAN","boundaryCode":"MICROPLAN_MO","projectId":null,"startDate":1735810905674,"endDate":0,"additionalDetails":{"source":"microplan","disease":"MALARIA","resourceDistributionStrategy":"MIXED"},"resources":[],"boundaries":[],"deliveryRules":[],"auditDetails":{"createdBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","lastModifiedBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","createdTime":1733218905816,"lastModifiedTime":1733218919304}},"RequestInfo":{}}
/plan-service/config/_update
POST
`{"PlanConfiguration":{"id":"660fb389-5e60-4c43-b6ce-b1c109b23f54","tenantId":"mz","name":"Malaria-Bednet Campaign-Fixed Popp0099","campaignId":"8c413d61-c411-4c33-b6eb-76ea005a84c9","status":"DRAFT","files":[],"assumptions":[],"operations":[],"resourceMapping":[],"auditDetails":{"createdBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","lastModifiedBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","createdTime":1733218906001,"lastModifiedTime":1733218924572},"additionalDetails":{"key":"2"},"workflow":null},"RequestInfo": {} }
The microplan creation process is organised into multiple steps using a stepper for better navigation. The first step in this process is Microplan Details, divided into two sections: Campaign Details and Microplan Details. This document provides an overview of these sections.
The Campaign Details section collects critical information about the campaign to set up the microplan.
Title: Enter the campaign details Guides users to input required campaign information.
Description: Please enter the required details to proceed with the microplan setup. Explains the purpose of this section.
Localisation: Both the title and description are fully translatable into multiple languages.
1. Disease Identified for the Campaign
Description: Select the disease targeted for the campaign.
Field Type: Dropdown
Default Value: Malaria
Mandatory: Yes
Usage: Use the dropdown or type to filter options.
Localization: The label is translatable.
2. Type of Campaign
Description: Specify the type of campaign.
Field Type: Dropdown
Default Value: None (user must select a value)
Mandatory: Yes
Usage: Select the type from the dropdown.
Localization: The label and options are localizable.
3. Resource Distribution Strategy
Description: Choose a strategy for distributing resources.
Field Type: Dropdown
Default Value: None (user must select a value)
Mandatory: Yes
Usage: Select a strategy aligned with campaign goals.
Localization: Fully supports translations for the label and dropdown options.
Dropdown Menu:
Accepts text input for filtering options.
Includes a dropdown arrow icon for selection.
Fields marked with an asterisk (*) are mandatory.
Users must complete all required fields to proceed.
Validation rules and error messages are localizable.
The Microplan Details section focuses on naming the microplan for reference and identification in subsequent steps.
1. Campaign Details Summary
Displays a summary of the campaign information entered:
Campaign Disease: Malaria
Campaign Type: SMC Campaign
Resource Distribution Strategy: House-to-House
2. Name of the Microplan
Description: Provide a unique name for the microplan.
Field Type: Text Input
Mandatory: Yes
The name must be between 3 and 64 characters in length.
Numeric values alone are not allowed.
Allowed special characters: -
, _
, (
, )
, &
.
Naming Regex MDMS: https://unified-qa.digit.org/workbench-ui/employee/workbench/mdms-search-v2?moduleName=hcm-microplanning&masterName=MicroplanNamingRegex
Provides the regex pattern used to validate microplan names.
Naming Convention Info MDMS: https://unified-qa.digit.org/workbench-ui/employee/workbench/mdms-search-v2?moduleName=hcm-microplanning&masterName=MicroplanNamingConvention
It contains detailed information about naming conventions and guidelines.
Suggested Name: The system automatically suggests a microplan name based on campaign details. You can use this suggested name or provide a unique name that matches the naming rules.
Example: "Malaria-Bednet Campaign-Fixed Post & House-to-House-29 Nov 24"
Localization: Instructions and validation messages are fully translatable.
/project-factory/v1/project-type/create
POST
{ "hierarchyType": "ADMIN", "tenantId": "mz", "action": "draft", "campaignName": "test90", "resources": [], "projectType": "MR-DN", "additionalDetails": { "beneficiaryType": "INDIVIDUAL", "key": 2 }, "RequestInfo": {} }
/project-factory/v1/project-type/search
POST
{ "tenantId": "mz", "ids": [ "2a2491a7-c52d-4305-8b5b-9aa10ae44168" ], "pagination": {}, "RequestInfo": {} }
/plan-service/config/_create
POST
{ "PlanConfiguration": { "tenantId": "mz", "name": "Malaria-Bednet Campaign-Fixed Post & HDec 24", "campaignId": "52fea5b5-e7d2-424a-89ee-d167443314a9", "status": "DRAFT", "files": [], "assumptions": [], "operations": [], "resourceMapping": [], "additionalDetails": { "key": "2" } }, "RequestInfo": {} }
/plan-service/config/search
POST
{ "tenantId": "mz", "pagination": {}, "RequestInfo": {} }
The Microplan Assumptions step is designed to streamline the process of defining critical campaign-related hypotheses based on the selected Resource Distribution Strategy and Campaign Type. This step consists of two substeps:
Step 1: Registration and Distribution Process Selection
This screen adapts based on the Resource Distribution Strategy chosen during the Campaign Details step.
1. Mixed Strategy:
For campaigns following the Mixed Strategy, the system prompts users to provide details for both the registration and distribution processes. However, the same method cannot be selected for both.
Prompts:
How is the campaign registration process happening?
Users are required to select from predefined options such as House-to-House, Fixed, etc.
How is the campaign distribution process happening?
Users must select a different option from the registration process, tailored to the distribution method (e.g., House-to-House, Fixed, etc.).
This distinction ensures that the two processes are appropriately differentiated and configured.
2. Fixed or House-to-House Strategy:
For these strategies, users are prompted to specify the relationship between registration and distribution processes:
Question:
Is the registration and distribution process happening together or separately?
Options:
Together
Separately
The response determines how the system pre-configures subsequent assumptions.
Step 2: Assumptions Form
Once the registration and distribution process is selected, users proceed to the Assumptions Form, which dynamically adapts based on campaign-specific parameters.
The form fetches data from the MDMS and includes categories and assumptions customized according to:
The Campaign Type (e.g., Bednets, SMC)
The Resource Distribution Strategy (e.g., House-to-House, Fixed)
Example of some dynamic categories of Assumptions:
General Assumptions:
High-level parameters that apply to the overall campaign.
Registration Assumptions:
Assumptions specific to how and where registration activities occur.
Distribution Assumptions:
Parameters defining the methodology and logistics for distributing resources.
Commodities Assumptions:
Details about distributed items, such as the number of bednets per household.
Features of the Assumptions Form:
Input Values:
Users must input specific values for each assumption.
Validation Rules:
Assumption values must:
Be numerical and are mandatory. and fall within the range of 0 to 1000.
Contain at most two decimal places (e.g., 12.34 is valid, but 12.345 is not).
Adhere to a specific format, ensuring they match the pattern of a valid decimal or whole number (e.g., 123.45
or 678
).
Tooltips:
Each category includes input parameters with tooltips that provide detailed information when users hover over the respective field.
Manage Assumptions:
Users can add new assumptions or delete existing ones based on campaign needs.
Initiate Adding an Assumption:
Users can click the "Add New Assumption" button from the assumptions management interface.
Assumption Details Input:
A popup/modal is displayed with the following fields:
Choose Assumption: A dropdown or selection box to choose an existing assumption or create a new one.
Assumption Name: An input field where users specify the name of the new assumption.
Confirmation Options:
Cancel: Discards the changes and closes the popup/modal.
Add: Saves the new assumption after passing validation checks.
Deleting Assumption
Users can click the "Delete" button from the assumptions management interface.
Confirmation Options:
No: Discards the changes and closes the popup/modal.
Yes: Deletes the assumption.
Recovering deleted assumption:
Users can click the "Add New Assumption" button from the assumptions management interface and select the deleted assumption from the Choose Assumption dropdown.
Customization and Management:
Each assumption category and its parameters are dynamically tailored based on:
The selected Campaign Type
The chosen Resource Distribution Strategy
Below are the configurations needed for successfully setting up the microplan module:
citymodule needed to run campaign module in an environment:Link: https://github.com/egovernments/egov-mdms-data/blob/UNIFIED-QA/data/mz/tenant/citymodule.json
Refer to the below ID's link in QA:
roles need to be added in rolesLink:
The following roles have been added in the MDMS:
The following actions are added to the MDMS, the actions are mapped to roles using rolesactions.js
The following are the actions Idsmapped to the roles
Link for reference:
Each of the action id is a path for a specific action
The actions are defined in
The "hcm-microplanning" module in the application leverages various master data configurations to drive the microplanning and resource distribution functionalities. These configurations are crucial for ensuring that the system adheres to the right structure and rules for microplan creation, distribution strategy, and other related operations.
The following master details are part of the hcm-microplanning module
Each of the master will access their respective master data in the mdms.
Microplan Naming Convention - Defines the naming structure for microplans, ensuring consistency in naming across the system.
Microplan Naming Regex - Provides a regular expression used for validating microplan naming conventions.
Resource Distribution Strategy - Describes the strategy for resource allocation, ensuring resources are distributed effectively and according to predefined rules.
Roles for Microplan - Contains data related to the roles and permissions associated with the microplan process, ensuring appropriate access control.
Hypothesis Assumptions - Defines the assumptions used in the creation of hypotheses for microplanning, guiding the analysis process.
Rule Configure Output - Contains configurations related to the output of rules, guiding how the rules should be structured and the expected results.
Rule Configure Inputs - Contains configurations for the inputs required by rules, ensuring that the correct data is fed into the rule engine.
Auto-Filled Rule Configurations - Specifies the auto-filled configurations used by the system for rules, automating parts of the rule configuration process.
Rule Configure Operators - Defines the operators used in rule configurations, specifying the operations available for rule evaluation.
Registration and Distribution Happening Together or Separately - Specifies whether registration and distribution activities occur together or separately, affecting process flow.
Hierarchy Config - Contains the configuration data for the hierarchy structure, defining different levels of hierarchy and their relationships.
Village Road Condition - Captures the road conditions in different villages, which may affect resource distribution and microplanning strategies.
Village Terrain - Describes the terrain of various villages, helping in the planning of distribution strategies based on geographical factors.
Security Questions - Specifies the set of security questions used for user authentication and verification.
Facility Type - Defines the types of facilities available within the microplanning system, ensuring proper categorization.
Facility Status - Specifies the status of various facilities (e.g., operational, under construction), which helps in planning and distribution.
Vehicle Details - Contains information on available vehicles, used for the transportation of resources within the planning scope.
Context Path for User - Defines the user-specific context, ensuring the correct path is followed within the system based on the user's role and access.
DSS KPI Configs - Defines the configurations for the Key Performance Indicators (KPIs) used by the Decision Support System (DSS), guiding decision-making processes.
HierarchySchema: Defines the order of the boundaries
These master details are accessed and managed via the BASE_MASTER_DATA schema code to maintain data consistency, accuracy, and facilitate smooth operations within the hcm-microplanning module.
Global configuration needs to be added to environments.Link: https://github.com/egovernments/DIGIT-DevOps/blob/unified-env/deploy-as-code/helm/environments/unified-health-uat.yaml
MDMS Data is fetched from: https://github.com/egovernments/egov-mdms-data/tree/UNIFIED-DEV/data/mz/health/hcm-microplanning
Refer here to learn more about the setup environment.
Module
Use
rainmaker-common
For all common screen localisation messages like login, homepage, sidebar.
rainmaker-microplanning
For localisation messages related to microplanning and configurations.
rainmaker-boundary-${BOUNDARY_HIERARCHY_TYPE}
For boundary type localisations, using the BOUNDARY_HIERARCHY_TYPE from the MDMS.
rainmaker-Microplanning
Localisation messages for microplanning screens and related workflows.
rainmaker-workbench
Localisation messages for tools and utilities in the operational workbench.
rainmaker-mdms
Localisation messages for master data retrieved via MDMS.
rainmaker-schema
Localisation messages for schema definitions and configurations.
rainmaker-hcm-admin-schemas
Localisation messages for HCM administrative schemas and configurations.
The Boundary Selection step is the second step in the microplan creation process. It allows users to define the geographic areas (boundaries) where the campaign will be conducted. Users must select boundaries at different hierarchical levels to ensure accurate targeting.
Title: Select the boundaries where you want to run the campaign Provides clear instructions for selecting the geographic regions for the campaign.
Description: Boundaries are the administrative areas defined that you want to run a campaign in. Start selecting boundaries from the first level so that the boundaries present in the next level are available for selection. Explains the importance of hierarchical boundary selection.
Localization: Both the title and description can be translated into multiple languages.
The following fields represent the hierarchical administrative levels for boundary selection. These levels are dynamic and depend on the hierarchy definition configured in the system. An example hierarchy could look like this:
Country
Description: Select the top-level boundary (e.g., Country) where the campaign will be conducted.
Field Type: Dropdown
Mandatory: Yes
Usage: Selection of this level enables the next level in the hierarchy.
Province
Description: Select the second-level boundary (e.g., Province) within the chosen country.
Field Type: Dropdown
Mandatory: Yes
Usage: Available only after selecting the country.
District
Description: Select the third-level boundary (e.g., District) within the chosen province.
Field Type: Dropdown
Mandatory: Yes
Usage: Available only after selecting the province.
Administrative Post
Description: Select the next boundary level (e.g., Administrative Post) within the chosen district.
Field Type: Dropdown
Mandatory: Yes
Usage: Available only after selecting the district.
Locality
Description: Select the locality boundary within the chosen administrative post.
Field Type: Dropdown
Mandatory: Yes
Usage: Available only after selecting the administrative post.
Village
Description: Select the final-level boundary (e.g., Village) within the chosen locality.
Field Type: Dropdown
Mandatory: Yes
Usage: Available only after selecting the locality.
Note: The hierarchy structure (e.g., Country > Province > District > Administrative Post > Locality > Village) is just an example. Actual levels and labels will vary based on the specific administrative hierarchy configured in the system.
The number of levels and their labels (e.g., Country, Province, District) are not fixed and depend on the system's hierarchy definition.
Users must proceed sequentially, selecting each level to unlock the next.
Localization: All hierarchy level labels are fully translatable, allowing them to be displayed in different languages as required.
Dropdown Menu:
Hierarchical: The options in each dropdown depend on the selection made in the previous level.
Filtering: Text input is supported to filter options.
Validation: Ensures selections are made sequentially and that no level is skipped.
Localization: Error messages and validation prompts are fully translatable.
All fields marked with an asterisk (*) are mandatory.
Users cannot proceed without completing the selection at each level.
If boundaries are not selected down to the last level, or if any selected boundary does not have its child boundary selected, a proper error message is displayed.
Boundary Selection Overview Card
The Boundary Selection Overview Card displays details of the number of selected levels at each dynamically configured boundary level (e.g., Country, Province, District, etc.). It provides a quick summary of the selections made at each level, offering users an efficient way to track the progress of the boundary selection process.
It looks like the second update was missed. Here's the table with both updates correctly included:
/boundary-service/boundary-relationships/_search
POST
{ "tenantId": "mz", "hierarchyType": "MICROPLAN", "includeChildren": true, "RequestInfo": {} }
/boundary-service/boundary-hierarchy-definition/_search
POST
{ "BoundaryTypeHierarchySearchCriteria": { "tenantId": "mz", "limit": 1, "offset": 0, "hierarchyType": "MICROPLAN" }, "RequestInfo": {} }
/project-factory/v1/project-type/search
POST
{ "CampaignDetails" : { "tenantId": "mz", "ids": [ "730fb389-5e60-4c43-b6ce-b1c109b23f54" ]}, "RequestInfo": {} }
/plan-service/config/_search
POST
{ "PlanConfigurationSearchCriteria": { "tenantId": "mz", "id": "660fb389-5e60-4c43-b6ce-b1c109b23f54" } ,"RequestInfo": {} }
/project-factory/v1/project-type/update
POST
{ "CampaignDetails":{"id":"8c413d61-c411-4c33-b6eb-76ea005a84c9","tenantId":"mz","status":"drafted","action":"draft","campaignNumber":"CMP-2024-12-03-006616","isActive":true,"parentId":null,"campaignName":"Malaria-Bednet Campaign-Fixed Popp0099","projectType":"LLIN-mz","hierarchyType":"MICROPLAN","boundaryCode":"MICROPLAN_MO","projectId":null,"startDate":1735810905674,"endDate":0,"additionalDetails":{"source":"microplan","disease":"MALARIA","resourceDistributionStrategy":"MIXED"},"resources":[],"boundaries":[],"deliveryRules":[],"auditDetails":{"createdBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","lastModifiedBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","createdTime":1733218905816,"lastModifiedTime":1733218919304}},"RequestInfo":{}}
/plan-service/config/_update
POST
`{"PlanConfiguration":{"id":"660fb389-5e60-4c43-b6ce-b1c109b23f54","tenantId":"mz","name":"Malaria-Bednet Campaign-Fixed Popp0099","campaignId":"8c413d61-c411-4c33-b6eb-76ea005a84c9","status":"DRAFT","files":[],"assumptions":[],"operations":[],"resourceMapping":[],"auditDetails":{"createdBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","lastModifiedBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","createdTime":1733218906001,"lastModifiedTime":1733218924572},"additionalDetails":{"key":"2"},"workflow":null},"RequestInfo": {} }
The User Management screen enables the Microplan admin to manage user roles like 'Population Data Approver.' Only roles related to the microplan are displayed here.
The screen is accessed when user logins in as MICROPLAN_ADMIN, goes to Setup Microplan Card and clicks on the User Management link.
This page allows the Microplan Admin to view all registered people for different microplan-related roles, uploaded using bulk upload. When clicking on the corresponding employee in the microplan, the details of the employee are shown.
Administrators can search for users by Name or Contact Number.
Search supports partial string matching.
API Details
The /health-hrms/employees/_search API returns all roles related to the microplan. By default, it shows all roles, but when filtered, it only shows users with the selected roles.
End Point
Roles
/health-hrms/employees/_search
MICROPLAN_ADMIN
Use the role checkboxes on the left-hand panel to filter users based on their assigned roles.
By default all roles are shown in the table.
The roles are fetched from the mdms, module.master is hcm-microplanning.rolesformicroplan .
Link for hcm-microplanning.rolesformicroplan
When one or more checkboxes are selected for role-based filtering, the roles
query string parameter is set to match the selected checkboxes for the /health-hrms/employees/_search
API.
End Point
Roles
/health-hrms/employees/_search
MICROPLAN_ADMIN
Navigation Links
The user can go to the Bulk User Data and Download User Data by clicking on the links.
The Bulk Upload Users is used to create multiple users of various roles to the Microplan.
The Download Users Data allows administrators to view and download various user templates and employee details, including user credentials created through bulk creation.
Employee Details
By clicking on the row of the table the employee details can be viewed.
Navigating to employee details
window.location.href=microplan-ui/employee/hrms/details/${tenantId}/${row}
The data for the different roles are fetched from the MDMS using api call:
API Details
End Point
Roles
/mdms-v2/v2/_search
MICROPLAN_ADMIN
The Summary Screen is a critical page in the microplan setup process, where system administrators and program managers can review, validate, and edit the data configured for the microplan. It provides
User Roles
Actors: System Administrator / Program Manager
Administrative Boundaries: National / Country level
The summary screen consists of the following modules:
Microplan Details Displays the core information about the microplan, such as the campaign name, disease, and resource distribution strategy. The user can review the details and make necessary edits.
Campaign Boundary Shows the geographical administrative boundaries, including the country, province, district, administrative post, locality, and village levels. Users can review and edit the boundary data for each geographical level.
Data Management Displays data templates for population and facilities. Users can download the templates or edit the uploaded files.
Microplan Assumptions Shows the assumptions used in the microplan setup. Users can review and adjust these assumptions as necessary.
Formula Configuration Displays the configured formulas used in the microplan. Users can modify the formulas if required.
Data Validation Ensures that the data entered meets all the required criteria and can be validated before proceeding with the microplan.
User Access Management Displays the users and their roles in the microplan setup. Users can manage who has access to the microplan.
Based on the tab, the respective section of setup microplan is shown.
Its implemented by using ViewComposer and passing in the pages as cards in a array called Cards.
The data displayed on the pages is retrieved from the sessionData
, which is created whenever the user inputs data during the microplan setup process. As the user progresses through the setup, each section of the form they complete is captured and stored as formData
.
Edit Data
Description: Each section of the summary screen can be edited by clicking the Edit button. This will redirect the user to the corresponding section in the microplan setup for further configuration.
Implementation: The system sets the key value for the selected section and redirects the user to the relevant page based on that key.
Download Files
Description: The user can download files (e.g., population and facility data templates) by clicking the Download button where applicable.
Implementation: This functionality is described in the Data Management page, where users can access and download the uploaded templates and files.
Once satisfied with the configuration, the user clicks Complete Setup to finalize the microplan.
When the Complete Setup button is clicked, the /plan-service/config/_update is triggered, with 'workflow:initiate' sent as the payload.
/plan-service/config/_update
MICROPLAN_ADMIN
The User Tagging Screen allows the Microplan admin to tag available users to the microplan currently being set up, assigning them specific tasks and responsibilities.
The different roles involved in the various parts of the microplan are:
National Microplan Estimation Approver
National Facility Catchment Assigner
National Population Data Approver
Microplan Estimation Approver
Facility Catchment Assigner
Population Data Approver
Each role has its own user list (uploaded through User Management Bulk Upload), and the available jurisdictions is based on the boundaries selected in the Boundary Selection screen.
Each role will have its own screen. Here, we use the National Microplan Estimation Approver role as an example for assigning and unassigning users.
This screen is for assigning National microplan estimation approver to the current microplan.
Once the system administrator clicks on the ‘Assign National Microplan Estimation Approvers’ button, he/she will be prompted a pop-up to assign the users with ‘National Microplan Estimation Approver’ role to the ongoing microplan.
Here, the system admin will be able to assign/unassign a user to the ongoing microplan.
Search
The search request is made via /health-hrms/employees/_search
, using roles as query parameters (e.g., roles: ROOT_PLAN_ESTIMATION_APPROVER
). This returns all registered users with the specified role.
When the page loads, a request to /plan-service/employee/_search
retrieves all users currently assigned to the current microplan.
Assign
Upon clicking the assign button, the userServiceUuid
from the search response (/health-hrms/employees/_search) is used as the payload, along with the jurisdiction and role. For the National Microplan Estimation Approver role, the jurisdiction is pre-selected as the national level by default.
For other roles, the jurisdiction is automatically pre-selected based on the boundaries set in the Boundary Selection screen. This information is then sent to /plan-service/employee/_create to assign the user to the current microplan.
Unassign
Clicking the unassign button sets the active
attribute of PlanEmployeeAssignment
to false
via /plan-service/employee/_create
, updating the microplan accordingly.
API Flow:
/plan-service/employee/_search
MICROPLAN_ADMIN
/health-hrms/employees/_search
MICROPLAN_ADMIN
/plan-service/employee/_create
MICROPLAN_ADMIN
The process for assigning users to each role is the same: open the roles screen and assign registered users within the appropriate jurisdiction.
Assigning users to national roles is mandatory
The Bulk Upload Users functionality allows the System Administrator to create multiple users with various roles in the Microplan by uploading an Excel template containing user details.
Template generation
Editing template
Browsing and Uploading
Validating File
Submitting file
To fill up the details in excel sheet a template is downloadable. The template is created by using the api call to /project-factory/v1/data/_generate
The user fills up the template and making sure to fill it in a valid manner.
Fill in user details (Name, contact number, and email) in each sheet according to the role.
Do not assign the same user to both the Microplan Estimation Approver and National Microplan Estimation Approver roles.
Do not assign the same user to both the Facility Boundary Assigner and National Facility Boundary Assigner roles.
Do not assign the same user to both the Population Data Approver and National Population Data Approver roles.
When the user clicks on Browse in My Files, they can select a file of type .xlsx
, .xls
and only the downloaded template can be uploaded. Once the file is selected, the validation of the Excel file begins. This validation is performed using the following hook:
The file is then set in the state and validated through the below hook.
This hook returns fileUrl
, which contains the URL attribute. For example, the URL might look like:
This is a pre-signed URL generated by Amazon S3 (Simple Storage Service), which provides temporary access to a specific file stored in an S3 bucket.
When the fileUrl
is set, the file can be downloaded by clicking a button that uses the following hook:
When the files are selected, the following api calls are being made.
Actions is set to validate when the file is first selected its sent for payload for /project-factory/v1/data/_create
End Point
Method
/project-factory/v1/data/_create
MICROPLAN_ADMIN
/project-factory/v1/data/_search
MICROPLAN_ADMIN
This hook does the validation of the xlsx file uploaded.
The error description is shown in error details.
The action is set to create for the payload for /project-factory/v1/data/_create
The page goes
End Point
Roles
/project-factory/v1/data/_create
MICROPLAN_ADMIN
When the delete button is clicked, the uploaded file is deleted.
The Formula Configuration Screen allows users to configure resource estimation formulas based on assumptions and campaign strategies. Users can also choose whether the formula should be displayed on the Estimation Dashboard (Population Inbox Screen). Additionally, new formulas can be added as needed.
MDMS Integration for Autofilled Configurations
The formulas on the Formula Configuration Screen are dynamically autofilled based on data from the MDMS.
These configurations are tailored using specific keys that define the campaign type, distribution strategies, and processes.
Add Formula
To create a new formula, click Add Formula.
Define the Formula Name, Inputs, and select the appropriate Operator.
After creating the formula, users can choose whether to display it on the Estimation Dashboard.
Delete Formula
To remove a formula, click Delete next to the relevant formula.
If the formula is used in the campaign, the system will prompt the user to either reuse the deleted formula or define a new one.
Show on Estimation Dashboard
If the user wants the formula to appear on the Estimation Dashboard, check the Show on Estimation Dashboard box.
Unchecking the box will keep the formula available for calculations but will exclude it from the dashboard view.
Total Number of Bednets per Boundary
Formula:
Total Number of Bednets = Target Population / Number of Persons per Bednet
Dependency: Relies on assumptions like Target Population and Number of Persons per Bednet.
Action: The user can choose to show this formula on the Estimation Dashboard by selecting the Show on Estimation Dashboard checkbox.
Total Number of Bales per Boundary
Formula:
Total Number of Bales = Total Number of Bednets / Number of Bednets per Bale
Dependency: Relies on Total Number of Bednets and Number of Bednets per Bale assumptions.
Action: The user can delete this formula or add it to the Estimation Dashboard as needed.
The Download User Data screen allows administrators to view and download various user templates and employee details, including user credentials created through bulk creation.
Download Functionality:
Each listed file has a dedicated Download button to save the respective data locally.
Files are downloaded in .xlsx
format.
Implementation of the files displayed :
The /project-factory/v1/data/_search will return all the files uploaded related to microplan.
API Details:
End Point
Method
Payload
/project-factory/v1/data/_search
POST
{"RequestInfo": {},
SearchCriteria: {tenantId: "mz", type: "user"}}
The API will return a ResourceDetails
array containing all the filestore IDs related to the microplan. Each entry will include the fileStoreId
, processedFilestoreId
, and status
Status
The files are downloadable only if the status of the files are "completed",
if the status of the file is "invalid" in resouceDetails.status then the file is not downloadable.
Download Button:
Upon clicking the download button, the following Digit function is invoked using the file's .processedFilestoreId
to enable the download functionality.
Once Downloaded:
The UserName and password are generated for each user in the downloaded sheet.
File Structure
The downloaded .xlsx
files may include the following data fields:
Name: The full name of the user.
Contact Number: The user's phone number.
Email: The user's email address.
Roles: The designated role(s) for each user (e.g., Population Data Approver).
Navigation:
Use the Back button to exit the download screen.
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.
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.
The table lists the microplans in a tabular format. Each row represents a microplan, and the columns provide detailed information:
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.
Once the system administrator completes the microplanning setup, including defining campaign boundaries, configuring facilities, and assigning roles, the Supervisor Flow begins.
The Supervisor Flow for managing microplans enables supervisors to track, edit, validate, and finalise microplans associated with public health campaigns. Each microplan provides specific details about campaigns, statuses, and associated actions, ensuring effective campaign execution.
The table below outlines roles, their corresponding role codes, and descriptions of responsibilities for supervisors:
The Population Data Validation and Approval screen is designed for population data approvers to ensure the accuracy and consistency of population data submitted for villages. This screen allows approvers to validate, correct, and approve data, ensuring the integrity of the data used for resource planning.
Header Section
Microplan Name: Displays the name of the current microplan being reviewed.
Logged-in User: Indicates the user role and account.
All values are dynamically updated based on the real-time census data.
These values are sourced directly from microplan-specific KPIs, which reflect any actions taken by data approvers.
As census data is reviewed, corrected, or approved, the values will change accordingly.
Filters and Search
Administrative Hierarchy and Area Selection: Dropdown menus for selecting specific administrative areas (e.g., district and village).
Search and Filter Options:
Workflow Status Filters:
Pending for validation
Pending for approval
Validated
Assigned to Filters:
Assigned to me
Assigned to all
Buttons: Apply Filter, Clear
Population Data Table
Action Buttons
View Logs: Displays historical changes and logs related to a specific village's data
4.1. Role-Based Permissions and Actions
Population Data Approver (PDA)
The Population Data Approver is responsible for validating population and editing data. Their responsibilities include:
Validating Data:
Cross-check the uploaded data with the confirmed population to ensure accuracy.
Editing Data:
Modify the village population data if discrepancies are found, with a reason logged for each change and the data is sent back for approval.
When No Data Is Assigned:
If no data is assigned to the PDA, a "Back" button is shown, allowing them to return to the previous screen.
Root Population Data Approver (RPDA)
The Root Population Data Approver has all the functionalities of a PDA and additional capabilities, to finalize population data. Their responsibilities include:
Editing Data:
Modify the village population data if discrepancies are found, with a reason logged for each change.
Approving or Sending Data for Correction:
Once the population data is validated, the RPDA can either approve it or send it back for correction if further issues are identified.
Approval Workflow:
If someone from the below hierarchy modifies and sends the data for approval, the RPDA can approve it. For example, if a province-level user sends the data back for approval, the RPDA will receive the application for approval and validation.
Finalizing Actions:
If all the villages within the selected microplan have been validated and no further changes are required, the RPDA will see a "Finalize Actions" button at the footer of the page.
The "Finalize Actions" button will lock the data and prevent further modifications once clicked, marking the end of the validation process for the selected microplan population data.
After finalizing the population data a success screen will be shown, indicating that population data is finalized.
Additional Notes
Once the population data reaches the national-level data approver and the validation is finalized, the system will disable all action buttons. The status will be set to "CENSUS_APPROVED" and no further changes can be made. At this point, users can only view the details of the data but will not be able to perform any additional actions, such as editing or approving the data.
Population supervisors will only see the boundaries in their inbox that fall under their jurisdiction.
1.Overview
The Facility Catchment Assigner role is responsible for mapping campaign facilities/points of service (POS) to their respective catchment villages. This mapping ensures that estimation of resources for campaign can be done accurately based on the facilities/POS and the villages assigned to them.
Assign Facilities to Villages:
Map facilities/POS to the villages within their assigned administrative boundaries.
Monitor Facility and Village Mappings:
Ensure that all villages and facilities are appropriately mapped for the campaign.
Microplan Name:
Displays the name of the current microplan being worked on.
Logged-in User:
Displays the role and account of the logged-in user (Facility Catchment Assigner).
The dashboard provides a summary of the facilities and villages that are part of the user's administrative boundaries.
Cards
Villages with Mapped Facilities/POS:
Displays the count of villages assigned to mapped facilities/POS within the administrative boundary.
Facilities with Mapped Villages:
Displays the count of facilities that have assigned villages in the administrative boundary.
The following master details are part of the Facility Catchement Mapping:
Facility Type: The type of facility (e.g., Warehouse, Health Post).
Facility Status: Status of the facility (e.g., Permanent, Temporary).
Residing Village: The villages where the facilities are located.
Facility Search:
Allows the user to search for specific facilities based on partial string matches.
Filters:
Facility Type: Filters by the type of facility (e.g., Warehouse, Health Post).
Facility Status: Filters by the facility's status (e.g., Permanent, Temporary).
Is Fixed Post?: Filters by whether the facility is a fixed post or not.
Residing Village: Filters by the villages where the facilities are located.
The following details are available for each facility in the dashboard:
When the user clicks on a facility or assign button in facility row, a popup window opens displaying essential details about the selected facility, as well as options for managing unassigned and assigned villages for this facility.
Once all villages are assigned to their respective facilities and the mappings are complete, the national level facility catchment assigner can finalize the assignment.
Finalization Process
Finalize Mapping:
A “Finalize facility to village assignment” button will be available to finalize the facility-to-village mapping.
After finalizing the facility catchment mapping a success screen will be shown, indicating that facility assignment is done.
Once finalized, no further changes can be made, and the microplan estimation for the campaign will be triggered.
Finalized Mapping View:
After finalization, the mapping cannot be modified, and the dashboard will display the finalized assignments for reference.
6.End Points
The document provides an interactive interface for supervisors to manage and track microplans. It displays role-based activity cards that guide users through tasks such as validating population data, assigning facilities, and approving microplan estimations. The available activities are dynamically presented based on the user’s role (Root or Normal) and the current workflow status of the microplan, ensuring that supervisors only see the actions relevant to their responsibilities at each stage of the microplan.
Microplan Name Display:
A prominently displayed label at the top of the interface that shows the name of the selected microplan.
Activity Options:
Displays a list of activities as clickable items. Selecting an activity navigates the user to the corresponding detailed workflow.
1. Validate & Approve Population Data
Purpose: Ensures the population data associated with the microplan is accurate and approved for further processing.
Steps:
Review uploaded population data for completeness and correctness.
Approve or flag data for revision as needed.
Roles Involved:
ROOT_POPULATION_DATA_APPROVER: Can review, approve, or send back population data, as well as finalised population data.
POPULATION_DATA_APPROVER: Can review, approve, or send back population data.
Role-Based Access:
This card is visible based on the user role and the wfStatus
that aligns with the data validation stage.
2. Assign Facilities to Villages
Purpose: Assign healthcare or distribution facilities to specific villages or areas within the campaign's scope.
Steps:
Map villages to designated facilities.
Confirm assignments to ensure logistical accuracy.
Roles Involved:
ROOT_FACILITY_CATCHMENT_MAPPER: Assign and unassign facilities to villages, and finalise facility assignments.
FACILITY_CATCHMENT_MAPPER: Assign and unassign facility to villages.
Role-Based Access:
This card appears only when the wfStatus
indicates that facility assignment is the next step.
3. Validate & Approve Microplan Estimations
Purpose: Review and finalise the estimated resources, population coverage, and other metrics calculated for the microplan.
Steps:
Check estimations for accuracy and alignment with campaign objectives.
Approve or request adjustments as necessary.
Roles Involved:
ROOT_PLAN_ESTIMATION_APPROVER: Can approve or request adjustments for microplan estimations, also finalized microplan estimation.
PLAN_ESTIMATION_APPROVER: Can approve or request adjustments for microplan estimations.
Role-Based Access:
The card is displayed based on wfStatus
of the plan configuration, indicating readiness for estimation validation.
Select an Activity: Choose one of the available activities depending on the current stage of the microplan.
Proceed to the Next Screen: Click the activity to access its detailed workflow interface.
Role-based Permissions: Certain activities might be restricted based on user roles and permissions.
Sequential Workflow: Activities must be completed in sequence for effective campaign execution:
Validate Population Data
Assign Facilities
Approve Microplan Estimations
Progress Tracking: Ensure tasks are not repeated and assignments remain aligned with campaign objectives.
1.Overview
When a user clicks on a village name in the Population Data Table, they are directed to the Village Details Page, which provides detailed information about the selected village.
2.Header Information
Microplan Name: Displays the name of the microplan associated with the village.
Displays the Hierarchy of the village.
3.Security & Accessibility
Village Security: Provides an input field for entering security details about the village.
Master Details :
Security Questions
Is your village prone to civil unrest like violent protests, riots, etc.? Captures the frequency of civil unrest occurrences using the following options:
All the time (At least once a month): Frequent civil unrest.
Often (At least once a year): Civil unrest occurs occasionally but is a notable concern.
Rarely (Once in 2–3 years): Rare civil unrest.
Never: No recorded instances of civil unrest.
How often do the security forces patrol the village? Measures the frequency of security patrols to ensure safety, with the following options:
Every day: Daily security patrols.
Often (At least once a week): Regular but less frequent patrols.
Rarely (Once in a month): Infrequent security patrols.
Never: No security patrols.
Village Accessibility: Allows entering accessibility details for the village.
Master Details :
Village Road Condition: Captures the type of road infrastructure present in the village. The options include:
Concrete: Indicates the presence of a well-paved concrete road.
Gravel: Represents roads made of gravel.
Dirt: Denotes unpaved roads made of dirt or soil.
No Road: Indicates the absence of any road infrastructure.
Village Terrain: Specifies the geographical terrain of the village. The available options are:
Mountain: Villages located in mountainous areas.
Forest: Villages surrounded by dense forest areas.
Plain: Villages situated in flat, open landscapes.
Desert: Villages located in arid, desert regions.
The data displayed here can be reviewed, modified, and validated by the appropriate users, depending on their role.
Data Table:
Note : The data inside table will change based on selected campaign.
Note : the data inside table will change based on selected campaign.
Actions:
Edit Population Data: If needed, the confirmed population data can be modified.
Cancel: Discards any changes made to the population data.
Submit and Validate:
If the Root Population Data Approver (RPDA) is logged in, they can directly validate the data.
If the Population Data Approver (PDA) is logged in, the data will move to the "Pending for Approval" status and will need further validation by higher-level approvers.
5.Comment Logs
View Comment Logs: This feature displays the history of changes and comments made about the village's population data, enabling transparency and tracking.
MDMS Data is fetched from:
MDMS Data is fetched from:
MDMS Data is fetched from:
Administrative Boundary
Hierarchy
Highest Boundary
Country
Lower Levels
Province, District, Admin Post, Locality ( Lower Level Boundaries)
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.
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.
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
Role Name
Role Code
Description
Population Data Approver
POPULATION_DATA_APPROVER
Responsible for validating the population data, ensuring its accuracy, including the ability to edit data, approve, or send data back for correction.
Root Population Data Approver
ROOT_POPULATION_DATA_APPROVER
Responsible for validating the population data, ensuring its accuracy, including the ability to edit data, approve, or send data back for correction. Has additional permissions, including the ability to finalized population data.
Facility Catchment Mapper
FACILTIY_CATCHMENT_MAPPER
Responsible for assigning facility to villages.
Root Facility Catchment Mapper
ROOT_FACILITY_CATCHMENT_MAPPER
Responsible for assigning facility to villages. Has additional permissions, including the ability to finalized facility catchment.
Plan Estimation Approver
PLAN_ESTIMATION_APPROVER
Responsible for validating the plan data, ensuring its accuracy, including the ability to approve, or send data back for correction.
Root Plan Estimation Approver
ROOT_PLAN_ESTIMATION_APPROVER
Responsible for validating the plan data, ensuring its accuracy, including the ability to approve, or send data back for correction. Has additional permissions, including the ability to finalized estimation for microplan.
Column
Description
Village Name
Name of the village under review.
Uploaded Target Population
Target population submitted for the village.
Confirmed Target Population
Approved target population for the village.
Uploaded Total Population
Total population submitted for the village.
Confirmed Total Population
Approved total population for the village.
Action Buttons
Includes View Logs for historical data and other validation actions.
Get chart data for a specific visualization
dashboard-analytics/dashboard/getChartV2
POST
{ "aggregationRequestDto": { "visualizationType": "METRIC", "visualizationCode": "censusUploadedTargetPopulation", "filters": { "COUNTRY": ["MICROPLAN_MO"], "status": ["PENDING_FOR_VALIDATION"], "planConfigurationId": ["246cfc95-b4b0-43e8-b375-dd44333cc881"], "tenantId": ["mz"] }, "moduleLevel": "CENSUS" }, "headers": { "tenantId": "mz" } }
Search census data
census-service/_search
POST
{ "CensusSearchCriteria": { "tenantId": "mz", "source": "246cfc95-b4b0-43e8-b375-dd44333cc881", "status": "PENDING_FOR_VALIDATION", "assignee": "a7431b92-5db5-46b1-9b5b-33272ba8dbfc", "jurisdiction": ["MICROPLAN_MO"], "limit": 50, "offset": 0 } }
Search business services
egov-workflow-v2/egov-wf/businessservice/_search
POST
SearchParams{
tenantId=mz,
businessServices=CENSUS
}
Search plan employees
plan-service/employee/_search
POST
{ "PlanEmployeeAssignmentSearchCriteria": { "tenantId": "mz", "active": true, "planConfigurationId": "246cfc95-b4b0-43e8-b375-dd44333cc881", "role": ["POPULATION_DATA_APPROVER", "ROOT_POPULATION_DATA_APPROVER"], "employeeId": ["a7431b92-5db5-46b1-9b5b-33272ba8dbfc"], "limit": 5, "offset": 0 } }
Search project type by campaign ID
project-factory/v1/project-type/search
POST
{ "CampaignDetails": { "tenantId": "mz", "ids": ["5b5a49ca-584c-4226-bbd6-98cddd95ef78"] } }
Search plan configuration details
plan-service/config/_search
POST
{ "PlanConfigurationSearchCriteria": { "tenantId": "mz", "id": "246cfc95-b4b0-43e8-b375-dd44333cc881" } }
Facility Detail
Description
Facility Name
Displays the name of the facility.
Facility Type
Displays the type of facility (e.g., Warehouse, Health Post).
Facility Status
Displays whether the facility is permanent or temporary.
Capacity
Shows the facility's capacity (e.g., Bales for bednets or Blisters for SMC campaigns).
Assigned Villages
Shows the number of villages assigned to the facility.
Serving Population
Displays the total population being served by the facility.
Fixed Post
Indicates if the facility is a fixed post.
Residing Village
Shows the name of the village where the facility resides.
Purpose
Endpoint
Method
Payload
Search for facilities
/plan-service/plan/facility/_search
POST
{ "PlanFacilitySearchCriteria": { "limit": 10, "offset": 0, "tenantId": "mz", "planConfigurationId": "297699ef-0041-4421-a4ae-acdd89c78e80", "jurisdiction": ["MICROPLAN_MO"], "facilityName": "", "residingBoundaries": [] } }
Search for project types
/project-factory/v1/project-type/search
POST
{ "CampaignDetails": { "tenantId": "mz", "ids": ["395adc89-6030-4347-ae5c-32a059f5aae5"] } }
Fetch chart data
/dashboard-analytics/dashboard/getChartV2?_=1733293436271
POST
{ "aggregationRequestDto": { "visualizationType": "METRIC", "visualizationCode": "totalFacilitiesWithMappedVillages", "filters": { "COUNTRY": ["MICROPLAN_MO"], "planConfigurationId": ["297699ef-0041-4421-a4ae-acdd89c78e80"], "tenantId": ["mz"] }, "moduleLevel": "MICROPLAN-FACILITY" }, "headers": { "tenantId": "mz" } }
Search census data
/census-service/_search
POST
{ "CensusSearchCriteria": { "tenantId": "mz", "facilityAssigned": false, "source": "297699ef-0041-4421-a4ae-acdd89c78e80", "jurisdiction": ["MICROPLAN_MO"] } }
Search for employees assigned to a plan
/plan-service/employee/_search?_=1733293435767
POST
{ "PlanEmployeeAssignmentSearchCriteria": { "tenantId": "mz", "active": true, "planConfigurationId": "297699ef-0041-4421-a4ae-acdd89c78e80", "employeeId": ["55392d76-9d87-4d4f-9ae9-2f44ff6968f2"], "limit": 5, "offset": 0 } }
/egov-workflow-v2/egov-wf/process/_search
Search process history for this plan
ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_PLAN_ESTIMATION_APPROVER, PLAN_ESTIMATION_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER, MICROPLAN_VIEWER
/egov-workflow-v2/egov-wf/businessservice/_search
Search workflow business services by tenant ID and plan
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
Retrieve plan configuration details by configuration ID
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
Village Name
Uploaded Total Population
Uploaded Target Population
Confirmed Total Population
Confirmed Target Population
Gblebo Town
(Total population submitted)
(Target population submitted)
(Total population validated)
(Target population validated)
Endpoint
Purpose
Role
/census-service/_update
To Update the census data
POPULATION_DATA_APPROVER ROOT_POPULATION_DATA_APPROVER ROOT_FACILITY_CATCHMENT_MAPPER FACILITY_CATCHMENT_MAPPER
/egov-workflow-v2/egov-wf/process/_search
Search process history for this plan
ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_PLAN_ESTIMATION_APPROVER, PLAN_ESTIMATION_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER, MICROPLAN_VIEWER
The resource estimation service is responsible for processing various file formats to estimate resources, generating microplans, uploading result sheets, and updating the HCM Console.
Knowledge of SpringBoot.
Knowledge of Git or any version control system.
Knowledge of RESTful web services.
Knowledge of the Kafka and Postgres.
Knowledge of egov-mdms service, egov-filestore, boundary-service, project-factory and egov-localization will be helpful.
File Parsing and Resource Estimation:
The service processes multiple file formats (Excel, Shapefiles, GeoJSON) to estimate the resources required for a microplanning campaign.
It reads the input data, applies predefined assumptions and formulas, and calculates the necessary resources.
Triggers for Plan-Facility Creation, Census Data Creation, and Plan Generation:
Plan-Facility Creation Trigger: When a facility file is uploaded, the service triggers the Plan-Facility Creation API from the project-factory
. This ensures that the facilities are created based on the file contents.
Census Data Creation Trigger: When a population file is uploaded, the service triggers the Census Data Creation process. This involves reading the population file, processing the data, and updating the system with the relevant census information.
Plan Generation Trigger: After the census data is approved, the service reads the updated population file, updates the census data, and triggers the resource estimation and microplan generation based on the latest data detailing the necessary resources and their distribution for the campaign.
Resource Mapping:
The service enriches the mapping of resource columns from the data upload to a predefined set of attributes required for each campaign. This ensures the resources are aligned with the necessary specifications.
Upload Updated Result Sheet:
After the microplan is created and have gone through the estimation approval process, the updated approved resource estimations sheet is uploaded to the filestore and updated back into the plan configuration ensuring the latest version of the resource data is securely stored and accessible.
HCM Console Integration:
The service integrates with the HCM Console, updating the project factory with the estimated resources. This ensures that the project factory always has the most accurate and up-to-date resource requirements for effective campaign planning and execution.
Mdms service
Filestore service
Project factory service
Plan service
Boundary service
Localization service
NA
Topic
Description
resource-microplan-create-topic
Pushes to plan service for microplan creation after resource estimation.
resource-plan-config-update-topic
Updates a plan configuration with INVALID_DATA status in case of exception while processing file.
Topic
Description
plan-config-update-topic
Triggers resource estimation, microplan creation, and campaign manager integration.
Below are the variables that should be configured well before deployment of the resource estimation service build image.
Add these ‘db-host’, ’db-name’, ’db-url’, ‘domain’, and all the digit core platform services configurations (persister, filestore, etc.) in respective environments.
Make sure to add the digit core services related secrets are configured in the respective environment secret file the way it's done here.
Localisation details here.
Configure all the MDMS data for plan service
Refer to the following:
- Plan service documentation
- https://github.com/egovernments/egov-mdms-data/tree/UNIFIED-QA/data/mz/health/hcm-microplanning
Title
Link
MDMS Technical Document
Filestore Service Documentation
Boundary Service Documentation
Localization Service Documentation
Project Factory Documentation
Plan Service Documentation
The Plan Service is a solution for managing plan configurations and microplans, enabling the creation, updating, validation, and processing of these plans and their associated components. This service supports data management for microplanning, including resource estimation, activity sequencing, and output generation. It can function as a standalone tool for microplanning or be integrated with HCM Console for campaign execution, monitoring, and reporting.
Knowledge of SpringBoot.
Knowledge of Git or any version control system.
Knowledge of RESTful web services.
Knowledge of the Kafka and Postgres.
Knowledge of eGov-mdms service and eGov-persister will be helpful.
Data Upload for Microplanning: Upload population, facility, and census data in formats like .xlsx (Excel)
, Shapefiles, and GeoJSON. Location coordinates are optional for microplanning.
Assumptions Configuration: Set up assumptions for estimation processes, including demographics, resource availability, and operational constraints.
Formula Configuration: Define formulas to calculate human resources, commodities, and budgets for accurate planning.
Activity Management: Define and manage activity sequences and dependencies for campaign execution.
Resource Estimation: Estimate and save the required resources for each activity, ensuring proper planning for materials and personnel.
Condition Monitoring: Set and monitor prerequisites for activities, ensuring necessary conditions are met before proceeding.
Target Setting and Tracking: Define and track performance metrics to ensure campaign goals are achieved.
Output Generation: Generate, save, and print microplans, ensuring comprehensive documentation for the campaign.
Employee Assignment: Assign roles based on hierarchy levels (Province, District, Village) and define employee roles (e.g., PLAN_ESTIMATION_APPROVER).
Jurisdiction Mapping: Link employees to specific jurisdictions, clarifying roles and geographical responsibilities.
Facility Assignment and Mapping: Associate facilities with specific plans, linking resources and operations to microplanning requirements.
Facility Details and Boundaries: Define facility IDs, residing and service boundaries, and metadata (e.g., facility type, capacity, and operational status).
Custom Metadata: Capture detailed information about each facility, such as fixed post status, population served, and resource capacities.
MDMS service
Persister service
Census service
Facility service
Project factory
User service
Workflow service
/plan-service
Topic
Description
plan-config-create-topic
Create plan configuration with assumption, operations, uploaded files.
plan-config-update-topic
Updates a plan configuration.
save-plan
Creates a microplan for a locality with provided resources, activities, or targets.
update-plan
Updates a microplan.
Topic
Description
resource-microplan-create-topic
Triggers microplan creation after resource estimation.
resource-plan-config-update-topic
Updates plan configuration from resource generator service.
Configure the role MICROPLAN_ADMIN for plan-service in the ‘ACCESSCONTROL-ROLES’ module.
Configure the action id(s) with the corresponding role code ‘ACCESSCONTROL-ROLEACTIONS’ module.
For Plan Service Role-Action mappings are as follows in the Dev environment.
Plan APIs
/plan-service/plan/_create
SYSTEM
/plan-service/plan/_search
ROOT_RESOURCE_ESTIMATION_APPROVER, RESOURCE_ESTIMATION_APPROVER
/plan-service/plan/_update
ROOT_RESOURCE_ESTIMATION_APPROVER, RESOURCE_ESTIMATION_APPROVER
/plan-service/plan/bulk/_update
ROOT_RESOURCE_ESTIMATION_APPROVER, RESOURCE_ESTIMATION_APPROVER
Plan configuration APIs
/plan-service/config/_create
MICROPLAN_ADMIN
/plan-service/config/_search
MICROPLAN_ADMIN
/plan-service/config/_update
MICROPLAN_ADMIN
Plan facility catchment APIs
/plan-service/facility/_create
SYSTEM
/plan-service/facility/_search
ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER
/plan-service/facility/_update
ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER
Plan employee assignment APIs
/plan-service/employee/_create
MICROPLAN_ADMIN
/plan-service/employee/_search
MICROPLAN_ADMIN
/plan-service/employee/_update
MICROPLAN_ADMIN
Below are the variables that should be configured before deployment of the plan service build image:
Add the value of plan service-related environment variables like the way it is done in the unified-uat environment yaml file and unified-health-uat environment yaml file (search for plan-service).
Add these ‘db-host’,’db-name’,’db-url’,’domain’, and all the digit core platform services configurations (persister, filestore, etc.) in the respective environments.
Make sure to add the DB (Postgres and Fyway) username and password in the respective environment secret yaml file the way it is done here.
Make sure to add the DIGIT core services-related secrets that are configured in the respective environment secret file the way it is done here.
Localisation details here.
Configure all the MDMS data for plan service as done in the QA environment. Data to configure:
UOM config
Metric config
Hypothesis’ assumptions config
Input rules config
Output rules config
Campaign Based Schema
Microplan status config
Map layers config
Map filters config
Preview Aggregates config
UI configs
Upload Config
Refer to the following: https://github.com/egovernments/egov-mdms-data/tree/UNIFIED-QA/data/mz/health/hcm-microplanning
Title
Link
MDMS Technical Document
Persister Technical Document
Census Service Technical Document
Facility Service Technical Document
Facility Service
Project Factory Technical Document
User Service Technical Document
Workflow Service Technical Document
API Contract
Postman Collection
The Census Service enables the creation and categorization of census records, ensures boundary validity, enforces user compliance, and automates record timeframes. With robust demographic data handling and advanced analysis, it supports precise planning and resource allocation while maintaining data integrity.
Knowledge of SpringBoot.
Knowledge of Git or any version control system.
Knowledge of RESTful web services.
Knowledge of the Kafka and Postgres.
Knowledge of eGov-mdms service and eGov-persister will be helpful.
Census Record Creation: Create census records for specific boundaries and categorize them by population type, such as people, animals, and plants.
Demographic Data Handling: Store population data by demographic variables (e.g., age, gender, ethnicity) for detailed analysis (e.g., if categorized by age:{"0-14": 1000, "15-24": 8000}
).
Boundary and User Validation:
Validate boundaries via the Boundary Service.
Verify user roles for compliance.
Manage and update census record validity periods.
Integration with Plan Service: Map facilities to boundaries via the Plan Facility API for seamless resource allocation and microplanning.
Boundary service
Plan service
Workflow service
Persister service
/census-service
Configure the role MICROPLAN_ADMIN, ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER for census-service in the ‘ACCESSCONTROL-ROLES’ module.
Configure the action id(s) with the corresponding role code ‘ACCESSCONTROL-ROLEACTIONS’ module.
For Census Service Role-Action mappings are as follows in the Dev environment.
Below are the variables that should be configured before deployment of the census service build image:
Add these ‘db-host’, ’db-name’, ’db-url’, ’domain’ and all the digit core platform services configurations (persister, boundary, etc.) in the respective environments.
NA
Role
Description
Role Code
Population Data Approver
Responsible for validating the population data, ensuring its accuracy, including the ability to edit data, approve, or send data back for correction.
POPULATION_DATA_APPROVER
Root Population Data Approver
Responsible for validating the population data, ensuring its accuracy, including the ability to edit data, approve, or send data back for correction.Has additional permissions, including the ability to finalize population data.
ROOT_POPULATION_DATA_APPROVER
Role
Description
Role Code
Facility Catchment Mapper
Responsible for assingning facility to villages
FACILITY_CATCHMENT_MAPPER
Root Facility Catchment Mapper
Has additional permissions, including the ability to finalize catchment mapping
ROOT_FACILITY_CATCHMENT_MAPPER
The system administrator can see the list of microplans on this page and perform certain actions on each microplan, if required.
The screen is accessed when the user logins in as MICROPLAN_ADMIN, goes to the Microplan Setup card, and clicks on the open microplans link.
The Open Microplans screen allows the microplan admin to see all the plans that they create. Microplans are categorised by their status, such as Drafted Setup, Completed Setup, Validation in Progress, and Finalised Microplan. A mMicroplan admin can search for microplans by name and perform actions based on the microplan’s current status.
The list of statuses displayed on the Open Microplans screen includes:
All: Default view showing all microplans created by the user.
Drafted Setup: Microplans that have still not been completed in setup microplans.
Completed Setup: Shows microplans for which setup is completed.
Validation in Progress: Displays microplans that are being validated by Population approvers, facility data approvers, and estimation approvers.
Finalized Microplan: This shows the microplans that have been fully validated and finalized.
In the Open Microplans screen, users can:
Search Microplan: Search for microplans using the microplan name. Fuzzy search is also available.
Filter Microplans by Status: Use tabs to filter microplans based on their status.
Perform Status-Specific Actions: Depending on the microplan's status, users can view, edit, or download finalised microplan estimations.
Frontend File Path:
How Search API works
Each of the tabs is associated with a tabId and each tabId is linked with a status, and after extracting the string query params in the URL, the payload for PlanConfigurationSearchCriteria.status is filled based on tabId.
Sample Payload:
1) /plan-service/config/_search:
This endpoint takes userUUID
as the planConfigSearchCriteria
and returns all the different plan objects related to the microplans created by the logged-in system admin.
2)/project-factory/v1/project-type/search
Will take the campaignId from the plan Object and the tenantId, and will give back the campaign Object(campaign name, campaign disease, campaign type, etc).
End Point
Role
/plan-service/config/_search
MICROPLAN_ADMIN
/project-factory/v1/project-type/search
MICROPLAN_ADMIN
Based on the status of microplan different actions are available.
Each of the different tabs represents the different stages of the microplan.
The Edit (Drafted Microplans)
When the microplan status is ["DRAFT"], edit is available. Clicking on it redirects to the last edited page of the setup microplan.
View Summary (Setup Completed):
When the microplan status is ["EXECUTION_TO_BE_DONE"] or ["CENSUS_DATA_APPROVAL_IN_PROGRESS", "CENSUS_DATA_APPROVED", "RESOURCE_ESTIMATION_IN_PROGRESS"], view summary is available. Clicking on it redirects to the summary page of the setup microplan.
Download Microplan(Microplan Finalized):
When the status of the microplan is ["RESOURCE_ESTIMATIONS_APPROVED"], then clicking on the download will download the microplan sheet using the hook
The field, and campaign name are extracted from the plan object and the name of the generated file is the customName.
1.Overview
When the user clicks on a facility, this popup window opens displaying essential details about the selected facility, as well as options for managing unassigned and assigned villages for this facility.
Facility Details Card
Upon selecting a facility, a Facility Details popup will display the following:
Facility Name: Name of the selected facility.
Facility Type: Type of facility, such as "Warehouse" or "Health Post."
Facility Status: Indicates whether the facility is temporary or permanent.
Capacity: Displays the capacity of the facility (e.g., the number of bales for bednet distribution or blisters for SMC campaigns).
Serving Population: The serving population currently being served by the facility.
Fixed Post: Indicates if the facility is a fixed post, which is typically a permanent, stationary facility.
Residing Village: The village where the facility is located or based.
Field Name
Description
Village Name
The name of the village (e.g., Tendeken-01, Dutorken).
Administrative Hierarchy
The administrative hierarchy to which the village belongs (e.g., Country, Province, District).
Administrative Area
The specific area within the hierarchy (e.g., Locality, Village).
Accessibility Level
Indicates the ease of accessing the village (e.g., View Details).
Security Level
The security conditions of the village (e.g., View Details).
Confirmed Target Population
The population size confirmed for the village.
Assignment Status
Indicates whether the village is currently assigned or unassigned to a facility.
Assigned Facility
Name of the facility to which the village is assigned (if applicable).
Actions
Options for assigning or unassigning a village.
Filter Options:
Select Administrative Hierarchy: Dropdown menu for selecting an administrative level (e.g., Country, Province, District).
Select Administrative Area: Dropdown menu for selecting a specific area within the hierarchy (e.g., Locality, Village).
Search: Search for villages by name or code.
Clear: Clears all selected filters and resets the search options.
3.Unassigned Villages and Assigned Villages
3.1.Unassigned Villages
This section allows the user to manage villages that have not yet been assigned to any facility. Users can select villages from this list and assign them to a facility.
3.2.Assigned Villages
This section displays the villages that have already been assigned to a facility. Users can manage these assignments, including unassigning a village if necessary.
Actions:
Assign: To assign a facility to a village, select the village from the unassigned list and click the "Assign" button.
Unassign: If a village is already assigned to a facility, users can unassign it by selecting the village and clicking the "UnAssign" button.
4.Notes:
Unassign: Clicking on unassign button will show a alert message that you want to unassign this village from the current selected facility.
Close: Clicking "Close" will exit the page without making any changes.
5.EndPoints:
Purpose
Endpoint
Method
Payload
Search census data
/census-service/_search
POST
{"CensusSearchCriteria":{"tenantId":"mz","source":"0dfe322d-727c-489f-a5a8-e8b7a0a43cc4","facilityAssigned":false,"jurisdiction":["MICROPLAN_MO"],"limit":10,"offset":0}
Update facility plan mapping data
/plan-service/plan/facility/_update
POST
{"PlanFacility":{"id":"11aa5150-0c6c-42ed-adb5-775fc02bfbbb","tenantId":"mz","planConfigurationId":"0dfe322d-727c-489f-a5a8-e8b7a0a43cc4","planConfigurationName":"bednetmixed-togregish2hdis name-1733377290309-8722","boundaryAncestralPath":"MICROPLAN_MO"}
The Microplan Estimation Approver screen is designed for supervisors to validate and approve microplan estimations within their assigned administrative boundaries. This screen allows approvers to validate, correct, and approve data, ensuring the integrity of the data used for resource planning.
Role
Description
Role Code
Plan Estimation Approver
Responsible for validating the estimation data, ensuring its accuracy, including the ability to edit data, approve, or send data back for correction.
PLAN_ESTIMATION_APPROVER
Root Plan Estimation Approver
Responsible for validating the estimation data, ensuring its accuracy, including the ability to edit data, approve, or send data back for correction.Has additional permissions, including the ability to finalize microplan estimation data.
ROOT_PLAN_ESTIMATION_APPROVER
Header Section
Microplan Name: Displays the name of the current microplan being reviewed.
Logged-in User: Indicates the user role and account.
All values are dynamically updated based on the real-time plan data.
These values are sourced directly from microplan-specific KPIs, which reflect any actions taken by data approvers.
As plan estimation data is reviewed, corrected, or approved, the values will change accordingly.
Filters and Search
Administrative Hierarchy and Area Selection: Dropdown menus for selecting specific administrative areas (e.g., district and village).
Search and Filter Options:
Workflow Status Filters:
Pending for validation
Validated
Assigned to Filters:
Assigned to me
Assigned to all
Buttons: Apply Filter, Clear
Plan Estimation Data Table
The table on the Microplan Estimation Validation Page displays key data for each village involved in the campaign, including the village name, status logs, assignee details, and facility name. It also includes important information such as road conditions, terrain, and security factors, which help assess the village’s readiness for plan activities. Additionally, the table presents validated population data, the number of households(based on selected campaign), and other critical metrics related to the plan data, ensuring that approvers have a comprehensive view of the plan estimation details before approval.
Action Buttons
View Logs: Displays historical changes and logs related to a specific plan estimation's data.
4.1. Role-Based Permissions and Actions
Plan Estimation Approver
The Estimation Data Approver is responsible for validating plan data. Their responsibilities include:
Validating Data:
Cross-check the uploaded data with the confirmed population to ensure accuracy.
Identifying Discrepancies:
If discrepancies are found, the PEA can flag the data for revision.
Approval Workflow:
The PDA at the appropriate level will see the application as pending for approval. In such cases, the PDA can validate and approve the data.
When No Data Is Assigned:
If no data is assigned to the PEA or all data assigned to him is validated, a "Back" button is shown, allowing them to return to the previous screen.
Root Plan Estimation Approver (RPEA)
The Root plan Estimation Approver has all the functionalities of a Plan Estimation Approver and additional capabilities, such as finalizing the microplan. Their responsibilities include:
Approving or Sending Data for Correction:
Once the plan data is validated, the RPEA can either approve it or send it back for correction if further issues are identified.
Approval Workflow:
If someone from the below hierarchy modifies and sends the data for approval, the RPEA can approve it. For example, if a province-level user sends the data back to a district-level user, who updates and sends it back for approval, the province-level RPEA will receive the application for approval.
Finalizing Actions:
If all the villages within the selected microplan have been validated and no further changes are required, the RPDA will see a "Finalize Actions" button at the footer of the page.
After finalizing the plan data a success screen will be shown, indicating that microplan is finalized.
The "Finalize Actions" button will lock the data and prevent further modifications once clicked, marking the end of the validation process for the selected microplan or district.
Once the plan estimation data reaches the national-level data approver and the validation is finalized, the system will disable all action buttons. The status will be set to "ESTIMATION_APPROVED" and no further changes can be made. At this point, you can download microplan estimation.
Estimation supervisors will only see the boundaries in their inbox that fall under their jurisdiction.
Purpose
Endpoint
Method
Payload
Fetch plan configuration details
/plan-service/config/_search
POST
{"PlanConfigurationSearchCriteria":{"tenantId":"mz","id":"0dfe322d-727c-489f-a5a8-e8b7a0a43cc4"}}
Fetch project types for a campaign
/project-factory/v1/project-type/search
POST
{"CampaignDetails":{"tenantId":"mz","ids":["fede1b71-464d-48be-a2ab-c27147df42c4"]}}
Search for assigned employees
/plan-service/employee/_search
POST
{"PlanEmployeeAssignmentSearchCriteria":{"tenantId":"mz","active":true,"planConfigurationId":"0dfe322d-727c-489f-a5a8-e8b7a0a43cc4","role":["PLAN_ESTIMATION_APPROVER","ROOT_PLAN_ESTIMATION_APPROVER"],"employeeId":["d3b6f2fb-97b7-4103-aa47-e03f0ba47b18"],"limit":5,"offset":0}}
Fetch workflow process details
/egov-workflow-v2/egov-wf/process/_search
POST
SearchParams{
tenantId=mz,
history=true,
businessIds=275135ab-2c22-48aa-8325-88f42c4d29ce
}
Search for plans by configuration
/plan-service/plan/_search
POST
{"PlanSearchCriteria":{"tenantId":"mz","planConfigurationId":"0dfe322d-727c-489f-a5a8-e8b7a0a43cc4"}}
Click to learn more.
The document guides the various configuration options available in the HCM Console. Proper configuration is crucial for optimising performance, ensuring security, and customising the user experience to meet specific needs. This document is designed to help system administrators, developers, and end-users understand and implement these configurations effectively. To learn more about HCM Service/App Configuration, Click .
The primary audience for this document includes:
System Administrators: Responsible for setting up and maintaining the application in various environments.
Developers: Need to understand configuration options for development, testing, and deployment.
End-Users: May require guidance on configuring user-specific settings via the user interface.
This schema manages the naming conventions for microplans, ensuring uniqueness and consistency across configurations.
Module Name: hcm-microplanning
Master Name: MicroplanNamingConvention
This schema validates the naming conventions for microplans by enforcing a specific format. Each entry includes a unique ID, the regex pattern, and its active status.
Module Name: hcm-microplanning
Master Name: MicroplanNamingRegex
This schema outlines strategies for resource allocation during microplanning. Each strategy has a unique code and a descriptive name to identify it.
Module Name: hcm-microplanning
Master Name: ResourceDistributionStrategy
Defines roles and their execution order within a microplanning process. Each role is associated with a unique code and a numerical order for prioritization.
Module Name: hcm-microplanning
Master Name: rolesForMicroplan
This schema encapsulates assumptions for different campaign types, including strategies for registration and distribution processes. It also organizes assumptions into categories, with each category having specific assumptions listed.
Module Name: hcm-microplanning
Master Name: HypothesisAssumptions
Details the outputs associated with rule configurations for microplanning. Each category defines its outputs, organized by order and relevance to specific campaigns.
Module Name: hcm-microplanning
Master Name: RuleConfigureOutput
Manages the inputs required for rule configurations during microplanning. Inputs are categorized and ordered, ensuring they align with relevant campaigns and strategies.
Module Name: hcm-microplanning
Master Name: RuleConfigureInputs
This schema automates the population of rule configurations based on predefined assumptions, outputs, and inputs, streamlining microplanning efforts.
Module Name: hcm-microplanning
Master Name: AutoFilledRuleConfigurations
Defines the operators available for creating rules in microplanning. Each operator has a unique name and code to identify its functionality.
Module Name: hcm-microplanning
Master Name: RuleConfigureOperators
Specifies whether registration and distribution processes are conducted together or separately. Each configuration includes a unique code and descriptive name.
Module Name: hcm-microplanning
Master Name: RegistrationAndDistributionHappeningTogetherOrSeparately
This schema represents road conditions in villages, which is crucial for microplanning logistics. Each entry contains a unique code, a descriptive name, and its active status, indicating whether the condition is currently considered in planning.
Module Name: hcm-microplanning
Master Name: villageRoadCondition
This schema categorizes village terrains to support better planning and resource allocation. Each terrain is identified by a unique code, a descriptive name, and its active status.
Module Name: hcm-microplanning
Master Name: villageTerrain
Defines a set of security questions used for user authentication or verification. Each question has a unique numeric ID, a textual question, an array of possible values, and a flag indicating if the question is mandatory.
Module Name: hcm-microplanning
Master Name: securityQuestions
Identifies different types of facilities involved in microplanning. Each type is defined by a unique code, a name, and its active status, making it easy to manage facility-specific operations.
Module Name: hcm-microplanning
Master Name: facilityType
Tracks the operational status of facilities. Each entry includes a unique code, a descriptive name, and a flag indicating whether the status is active.
Module Name: hcm-microplanning
Master Name: facilityStatus
Details of vehicles used in microplanning logistics, including type, manufacturer, model, capacity, and unit of measurement. Unique constraints ensure no duplicates for manufacturer-model-capacity combinations. The schema also references external schemas for vehicle type and unit of measurement.
Module Name: hcm-microplanning
Master Name: VehicleDetails
Defines the various types of vehicles used in microplanning, with each type identified by a unique string.
Module Name: hcm-microplanning
Master Name: VehicleType
Manages context path configurations for users, essential for customizing their environment. Each configuration includes a unique ID and a corresponding context path.
Module Name: hcm-microplanning
Master Name: ContextPathForUser
This schema configures Key Performance Indicators (KPIs) for Decision Support Systems (DSS). Each module can have multiple KPI configurations, including campaign-specific charts with attributes such as visualization type, code, order, and hierarchy levels.
Module Name: hcm-microplanning
Master Name: DssKpiConfigs
Configures the hierarchical structure used in microplanning. Each entry specifies the hierarchy type, the lowest level in the hierarchy, and ensures uniqueness.
Module Name: hcm-microplanning
Master Name: hierarchyConfig
Defines the configuration for Units of Measure (UOM) used in the system. Each UOM is identified by a unique uomCode
and is associated with a descriptivename
, such as "Kilogram" or "Meter". This schema ensures UOM codes are unique and provides a standardized way to reference measurement units across the application.
Module Name: hcm-microplanning
Master Name: Uom
Configures uploaded file types in the system, uniquely identified by a code. Each entry includes details like id, iconName, and required status, along with supported file types specifying fileExtension and namingConvention. Ensures code is unique for standardized file management.
Module Name: hcm-microplanning
Master Name: UploadConfiguration
Defines the configuration for metrics in the system. Each metric is uniquely identified by a code and includes a name and an active status. Ensures uniqueness of the code for standardized metric management.
Module Name: hcm-microplanning
Master Name: Metric
Configures data schemas for hierarchical and facility-based mapping. Each schema is uniquely identified by type, campaignType, and section and includes templates, facility data mappings, and properties for visualization and rules configuration. Supports hierarchy validation and resource mapping for comprehensive data management.
Module Name: hcm-microplanning
Master Name: Schemas
Defines a schema for common constants used in configurations. Each constant is uniquely identified by its name and must include both name and value fields, which are string types. This schema ensures uniqueness and standardization for constant values across applications.
Module Name: hcm-microplanning
Master Name: CommonConstants
This schema defines hierarchy configurations for various contexts like microplanning, campaigns, and consoles. It includes details like type, associated groups, departments, and boundaries, as well as the lowest and highest hierarchy levels for each configuration.
Module Name: HCM-ADMIN-CONSOLE
Master Name: HierarchySchema
Manages custom sheet data configurations for admin consoles. Each sheet has a unique title and type, along with structured data organized as arrays of objects with column-value pairs.
Module Name: HCM-ADMIN-CONSOLE
Master Name: customSheetData
Following are the service helm charts:
Census Service:
Plan Service:
Resource Generator:
Database Configuration Information
The configuration snippet provides the details required to set up and connect to a database, including environment-specific handling, credentials, schema information, and other related settings. Below is a structured breakdown:
Database Connection Information
Flyway Migration Information
General Notes
ConfigMap and Secrets Integration: Sensitive data like DB_USER
, DB_PASSWORD
, and Flyway credentials are securely retrieved from Kubernetes secrets (db
secret). Non-sensitive configurations like DB_HOST
and DB_NAME
are stored in ConfigMaps (egov-config
).
Namespace-Specific Configuration: The DB_URL
and DB_SCHEMA
are tailored for specific namespaces. For example, the "health" namespace uses a dedicated health-db-url
key and the namespace value for the schema.
Default Settings: Where applicable, defaults are provided. For instance, the schema defaults to "public"
and the port defaults to 5432
.
These configurations enhance the flexibility and usability of the core services of HCM-Microplanning, ensuring smoother operations and better alignment with user needs.
Persister config:
Helm chart details:
Add census service-related environment variables’ value like the way it is done in the and (search for census-service).
Make sure to add the DB (Postgres and flyway) username and password in the respective environment secret yaml file the way it is done.
Make sure to add the DIGIT core services-related secrets that are configured in the respective environment secret file the way it is done.
Localisation details .
Refer to learn more about the Helm Configurations.
Topic
Description
census-create-topic
Creates a census record for the specified boundary.
census-update-topic
Updates a census record.
census-bulk-update-topic
Updates a list of census records.
Topic
Description
resource-census-create-topic
Triggers census creation after resource estimation
update-plan-facility
Marks the boundaries in census where facility is assigned.
/census-service/_create
MICROPLAN_ADMIN
/census-service/_search
ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER
/census-service/_update
ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER
/census-service/bulk/_update
ROOT_POPULATION_DATA_APPROVER, POPULATION_DATA_APPROVER, ROOT_FACILITY_CATCHMENT_MAPPER, FACILITY_CATCHMENT_MAPPER
Title
Link
Persister Technical Document
Boundary Service Documentation
Plan Service Documentation
API Contract
Postman Collection
DB_URL
health-db-url
or db-url
from egov-config
URL for connecting to the database. Uses health-db-url
in the "health" namespace, else db-url
.
DB_HOST
db-host
from egov-config
Hostname or IP address of the database server.
DB_PORT
"5432"
Port number for database connection (default PostgreSQL port).
DB_NAME
db-name
from egov-config
Name of the database being connected to.
DB_SCHEMA
Namespace value ("health")
for Microplanning or "public"
Specifies the schema within the database. Defaults to "public"
if no namespace is provided.
DB_USER
username
from db
secret
Database username used for authentication.
DB_PASSWORD
password
from db
secret
Database password for authentication.
FLYWAY_USER
flyway-username
from db
secret
User for running Flyway migrations.
FLYWAY_PASSWORD
flyway-password
from db
secret
Password for Flyway migration user.
FLYWAY_LOCATIONS
flyway-locations
from egov-config
Directory or path for Flyway migration scripts.
SCHEMA_TABLE
schemaTable
from initContainers.dbMigration
Table name for tracking Flyway migrations.