User Interface Design

Overview

This page explains how to configure the UI for setting up Microplans using MDMS-driven configurations in the hcm-microplanning module.

Steps

Step 1: Understand UI Actions and Action IDs

Each Action ID represents a unique navigation path or user action in the Microplanning UI (for example, create microplan, configure resources, or review distribution).

• Action IDs are mapped to UI flows and screens.

• These actions are defined and resolved through configuration, not hardcoded logic.

Ensure all required actions for microplanning are correctly mapped before proceeding with master configurations.

City module file path - required to run the campaign module.

{
      "module": "Microplan",
      "code": "Microplan",
      "active": true,
      "order": 1,
      "tenants": [
        {
          "code": "mz"
        }
      ]
    }

egov-mdms-data/data/mz/ACCESSCONTROL-ROLEACTIONS/roleactions.json at UNIFIED-DEV · egovernments/egov-mdms-dataGitHub

Step 2: Configure Microplanning Masters in MDMS

The HCM-microplanning module relies on multiple MDMS masters to drive UI behaviour, validation, and workflows. Each master is accessed from MDMS and controls a specific part of the microplanning experience.

Core Microplanning Masters

Configure the following masters under the HCM-Microplanning module:

1. Microplan Naming Convention Defines the standard naming structure for microplans.

2. Microplan Naming Regex Validates microplan names entered in the UI.

3. Resource Distribution Strategy Controls how resources are allocated during microplanning.

4. Roles for Microplan Defines roles, permissions, and access levels for microplanning workflows.

5. Hypothesis Assumptions Provides predefined assumptions used during hypothesis creation.

---

Rule Configuration Masters

These masters drive rule-based logic and calculations shown in the UI:

1. Rule Configure Inputs Defines input parameters required by the rule engine.

2. Rule Configure Output Specifies expected outputs from rule execution.

3. Auto-Filled Rule Configurations Enables system-driven auto-fill of rule values.

4. Rule Configure Operators Lists operators available for rule evaluation.

---

Workflow and Hierarchy Masters

1. Registration and Distribution Mode Defines whether registration and distribution occur together or separately.

2. Hierarchy Config Defines hierarchical levels and their relationships.

3. Hierarchy Schema Specifies the order and structure of boundary hierarchies.

---

Geography and Infrastructure Masters

1. Village Road Condition Captures road accessibility data for villages.

2. Village Terrain Describes terrain characteristics influencing distribution planning.

3. Vehicle Details Lists available vehicles for resource transportation.

---

Facility and Security Masters

1. Facility Type Defines facility categories used in microplanning.

2. Facility Status Indicates operational status of facilities.

3. Security Questions Configures security questions used in authentication flows.

---

Context and Analytics Masters

1. Context Path for User Determines user-specific navigation and access paths.

2. DSS KPI Configs Defines KPIs used by the Decision Support System (DSS).

---

Master Schema

All the above masters are managed using the:

• Schema Code: BASE_MASTER_DATA

This ensures consistency, validation, and reuse across the microplanning UI.

Step 3: Verify MDMS Data Source

Ensure the required MDMS data is available and up to date:

• MDMS Repository: egov-mdms-data → data/mz/health/hcm-microplanning

All configured masters must exist here to render correctly in the UI.

Step 4: Configure Environment-Level Settings

Add global configuration entries for microplanning in the deployment environment file:

• Environment Config Location: DIGIT-DevOps → deploy-as-code/helm/environments/unified-health-uat.yaml

These settings ensure that the microplanning module is enabled and correctly resolved at runtime.

Step 5: Configure Localisation for Microplanning UI

Microplanning UI text is fully localisation-driven. Ensure translations are added to the correct modules:

Localisation Module	Usage
rainmaker-common	Common screens (login, homepage, sidebar)
rainmaker-microplanning	Microplanning workflows and configurations
rainmaker-boundary-${BOUNDARY_HIERARCHY_TYPE}	Boundary-level labels
rainmaker-Microplanning	Microplanning screen content
rainmaker-workbench	Operational tools and utilities
rainmaker-mdms	MDMS-driven master labels
rainmaker-schema	Schema definitions
rainmaker-hcm-admin-schemas	HCM admin and schema configuration text

Ensure localisation keys are available before testing the UI.

Step 6: Validate UI Behaviour

After configuration:

• Verify microplan creation screens

• Validate naming rules and regex enforcement

• Check rule-based auto-filled fields

• Confirm hierarchy-driven dropdowns and filters

• Ensure localisation renders correctly across all screens

Once all steps are completed:

• The Microplanning UI is fully configuration-driven

• No code changes are required for UI behaviour updates

• Changes in MDMS are reflected immediately in the UI

Reference File Links & Sample Payload

egov-mdms-data/data/mz/ACCESSCONTROL-ROLES/roles.json at UNIFIED-DEV · egovernments/egov-mdms-dataGitHub

Sample payload for adding roles in MDMS

MICROPLAN_ADMIN
ROOT_FACILITY_CATCHMENT_MAPPER
FACILITY_CATCHMENT_MAPPER
ROOT_POPULATION_DATA_APPROVER
POPULATION_DATA_APPROVER
ROOT_PLAN_ESTIMATION_APPROVER
PLAN_ESTIMATION_APPROVER

Role-action mapping

egov-mdms-data/data/mz/ACCESSCONTROL-ROLEACTIONS/roleactions.json at UNIFIED-QA · egovernments/egov-mdms-dataGitHub

Actions ID MDMS data

egov-mdms-data/data/mz/ACCESSCONTROL-ACTIONS-TEST/actions-test.json at UNIFIED-DEV · egovernments/egov-mdms-dataGitHub

HCM Microplanning master details

hcm.microplanning.MicroplanNamingConvention, hcm.microplanning.MicroplanNamingRegex
hcm.microplanning.ResourceDistributionStrategy, hcm.microplanning.RolesForMicroplan
hcm.microplanning.HypothesisAssumptions, hcm.microplanning.RuleConfigureOutput
hcm.microplanning.RuleConfigureInputs, hcm.microplanning.AutoFilledRuleConfigurations
hcm.microplanning.RuleConfigureOperators, hcm.microplanning.RegistrationAndDistributionHappeningTogetherOrSeparately
hcm.microplanning.HierarchyConfig, hcm.microplanning.VillageRoadCondition
hcm.microplanning.VillageTerrain, hcm.microplanning.SecurityQuestions
hcm.microplanning.FacilityType, hcm.microplanning.FacilityStatus
hcm.microplanning.VehicleDetails, hcm.microplanning.ContextPathForUser
hcm.microplanning.DSSKPIConfigs, hcm.microplanning.HierarchySchema

Hierarchy schema sample payload

  {
    "type": "microplan",
    "group": [
      "MALARIA"
    ],
    "hierarchy": "MICROPLAN",
    "department": [],
    "lowestHierarchy": "VILLAGE",
    "highestHierarchy": "COUNTRY",
    "splitBoundariesOn": "DISTRICT"
  }
]