Resource Estimation Service
Overview
The resource estimation service is responsible for processing various file formats to estimate resources, generating microplans, uploading result sheets, and updating the HCM Console.
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, egov-filestore, boundary-service, project-factory and egov-localization will be helpful.
Key Features of Resource Estimation Service
Parsing and Estimating Resources: It processes various file formats (Excel, Shapefiles, GeoJSON) to estimate necessary resources for microplanning by reading input data and applying assumptions and formulas.
Validation: It validates all file data for proper data types and updates plan configuration status based on exceptions.
Generating Microplans: It triggers the creation of micro plans based on the estimated resources and input data, detailing the resources required and their distribution for the campaign.
Uploading Results: It uploads the updated result sheet to a filestore, ensuring the latest version is securely stored and accessible.
Integrating with HCM Console: It updates the HCM Console with the estimated resources, reflecting accurate resource requirements for effective campaign planning and execution.
Service Dependencies
Mdms service
Filestore service
Project factory service
Plan service
Boundary service
Localization service
API Specification
NA
Sequence Diagram
Producer Details
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. |
Consumer Details
Topic | Description |
plan-config-update-topic | Triggers resource estimation, microplan creation, and campaign manager integration. |
Environment Variables Details
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.
MDMS Details
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
Reference Docs
Title | Link |
MDMS Technical Document | |
Filestore Service Documentation | |
Boundary Service Documentation | |
Localization Service Documentation | |
Project Factory Documentation | |
Plan Service Documentation | Plan Service |
Last updated
