Plan Service
Overview
The Plan Service manages plan configurations and microplans, including creating, updating, validating, and processing plan configurations, microplans, and various elements within a microplan. It can function as a standalone tool for microplanning or be used with DIGIT HCM for campaign execution and monitoring.
Pre-requisites
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.
Key Features of Plan Service
Data upload for Microplanning: Upload essential data for microplanning population and household estimates in various formats, including:
- .xlsx (Excel)
- Shapefiles
- GeoJSON
- Note: Location coordinates are not mandatory for microplanning.
Assumptions configuration: Configure assumptions essential for estimation processes.
Formula configuration: Set up formulae to calculate the estimated resources, such as human resources, commodities, and budgets.
Visualisation: Visualise the microplan on a map layer powered by GIS technologies.
Output generation: Generate, save, and print microplans.
Service Dependencies
MDMS service
Persister service
Base URL
/plan-service
API Specification
DB Diagrams
Microplan:
Plan Configuration:
Sequence Diagram
Producer Details
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. |
Consumer Details
Topic | Description |
resource-microplan-create-topic | Triggers microplan creation after resource estimation |
Configurations and Helm Chart Details
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.
| API EndPoints | Roles |
|---|---|
/plan-service/plan/_create | MICROPLAN_ADMIN |
/plan-service/plan/_search | MICROPLAN_ADMIN |
/plan-service/plan/_update | MICROPLAN_ADMIN |
/plan-service/config/_create | MICROPLAN_ADMIN |
/plan-service/config/_search | MICROPLAN_ADMIN |
/plan-service/config/_update | MICROPLAN_ADMIN |
Environment Variable Details
Below are the variables that should be configured before deployment of the plan service build image:
Add plan service-related environment variables’ value like the way it is done in the QA 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 flyway) 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 (to be updated).
MDMS Details
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 Schemahttps://app.gitbook.com/o/-MEQmzNGXk5ajuZujG7E/s/QcWfjoZoghzgUXIbmCOZ/~/changes/26/product-specification/technical-specification/resource-estimation-service
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
Reference Docs
Title | Link |
MDMS Technical Document | |
Persister Technical Document | |
API Contract | |
Postman Collection |
Last updated
