Resource Generator Service

Overview

The Resource Generator Service processes uploaded inputs to generate resource estimations and microplans.

It parses supported file formats, applies configured assumptions and formulas, triggers downstream creation flows, and publishes approved outputs back to the platform (including HCM Console).

Pre-requisites

• Spring Boot

• Git (or another version control system)

• REST APIs

• Kafka

• PostgreSQL

• Familiarity with MDMS, Filestore, Boundary, Project Factory, and Localisation (helpful)

Capabilities

File parsing and estimation

• Parses Excel, Shapefiles, and GeoJSON inputs.

• Applies configured assumptions and formulas to compute resource needs.

Triggers and orchestration

• Plan–facility creation: on facility file upload, triggers facility mapping creation via Project Factory.

• Census creation/update: on population file upload, triggers census ingestion flows.

• Microplan generation: once the census is approved, triggers estimation and microplan generation using the latest approved population data.

The service supports mixed registration and distribution strategies. It can intentionally leave some fields null based on the MixedStrategy master.

Resource mapping

• Maps uploaded columns into the expected campaign attributes.

• Validates schema compatibility before estimation runs.

Output publishing

• Uploads approved estimation sheets to Filestore.

• Writes the final Filestore reference back to the plan configuration for traceability.

HCM Console integration

• Publish estimated resources back to Project Factory so Console can surface the latest plan outputs.

Service Dependencies

• MDMS service

• Filestore service

• Boundary service

• Localisation service

• Census service

• Project Factory

• Plan Service

API Specification

Swagger:

SwaggerEditoreditor.swagger.io

Postman Collection

Sequence Diagram

Kafka topics

Producer topics

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 topics

Topic	Description
plan-config-update-topic	Triggers resource estimation, microplan creation, and campaign manager integration.

Deployment configuration

Environment variables

Configure values in your DIGIT DevOps environment YAMLs (search for resource / resource-generator):

• DB config: db-host, db-name, db-url, domain

• Core platform service configs (for example: persister, filestore)

• Secrets in the environment secrets file:

  • unified-qa-secrets.yaml

  • unified-uat-secrets.yaml

Localisation sheet:

• Localisation details

MDMS

MDMS for Resource Generator is tightly coupled to microplanning masters used by Plan Service.

References:

• Plan Service

• Microplanning MDMS JSON data (v0.2)

Reference Docs

• MDMS Service

• Filestore Service

• Boundary Service

• Localisation Service

• Project Factory - Campaign Manager

• Plan Service