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

• Plan Service Swagger Link

• Postman Collection Link

DB Diagrams

Microplan:

Plan Configuration:

Sequence Diagram

Producer Details

Consumer Details

Configurations and Helm Chart Details

• Persister config: https://github.com/egovernments/configs/blob/UNIFIED-QA/health/egov-persister/plan-service-persister.yml

• Helm chart details: https://github.com/egovernments/DIGIT-DevOps/tree/unified-env/deploy-as-code/helm/charts/health-services/plan-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.

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

- https://github.com/egovernments/DIGIT-DevOps/blob/unified-env/deploy-as-code/helm/environments/unified-qa.yaml

• 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