Open Microplans: System Admin

Overview

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 Microplan 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 the 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.

• Finalised Microplan: This shows the microplans that have been fully validated and finalised.

Interface Elements

The system administrator can see the list of microplans on this page and perform certain actions on each microplan, if required.

Open Microplan

The screen is accessed when the user logs in as MICROPLAN_ADMIN, goes to the Microplan Setup card, and clicks on the open microplans link.

User Actions

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.

File Path

Frontend File Path:

https://github.com/egovernments/DIGIT-Frontend/blob/console/health/micro-ui/web/micro-ui-internals/packages/modules/microplan/src/pages/employee/MyMicroplans.jsgithub.com

Business Logic

How the Search API works

Each of the tabs is associated with a tabId, and each tabId is linked with a status. After extracting the string query params in the URL, the payload for PlanConfigurationSearchCriteria.status is filled based on tabId.

Sample Payload:

PlanConfigurationSearchCriteria: { limit: 10, offset: 0, status: ["DRAFT"], tenantId: "mz", userUuid: "80abd698-3a65-4665-bcdb-d177083f6277", RequestInfo: {} }

API call flow

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).

Status-Specific Actions

Based on the status of the microplan, different actions are available.

Each of the different tabs represents a different stage of the microplan.

Logic Explanation

1. 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.

2. 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"], the view summary is available. Clicking on it redirects to the summary page of the setup microplan.

3. Download Microplan(Microplan Finalised):

• When the status of the microplan is ["RESOURCE_ESTIMATIONS_APPROVED"], then clicking on the download will download the microplan sheet using the hook

Digit.Utils.campaign.downloadExcelWithCustomName({ fileStoreId: fileId, customName: campaignName });,

The field and campaign name are extracted from the plan object, and the name of the generated file is the customName.

API Details

Endpoint	Role
/plan-service/config/_search	MICROPLAN_ADMIN
/project-factory/v1/project-type/search	MICROPLAN_ADMIN