Microplan Details

Overview

The microplan creation flow uses a stepper-based UI to guide users through configuration in a structured manner. The first step in this flow is Microplan Details, which is divided into two sections:

1. Campaign Details

2. Microplan Details

This step captures all essential information required before proceeding to resource planning and distribution.

Steps

Step 1: Configure Campaign Details

The Campaign Details section collects core information about the campaign under which the microplan will be created.

1.1 Section Header Configuration

• Title: Enter the campaign details Guides users to provide mandatory campaign information.

• Description: Please enter the required details to proceed with the microplan setup. Explains the purpose of the section.

• Localisation: Both title and description are fully localisable using standard localisation modules.

1.2 Configure Campaign Fields

Field 1: Disease Identified for the Campaign

• Purpose: Select the disease targeted by the campaign.

• Field Type: Dropdown

• Default Value: Malaria

• Mandatory: Yes

• UI Behaviour:

  • Supports typing to filter values

  • Dropdown selection with arrow indicator

• Localisation: Label and values are translatable.

Field 2: Type of Campaign

• Purpose: Define the campaign type.

• Field Type: Dropdown

• Default Value: None (user selection required)

• Mandatory: Yes

• UI Behaviour: Dropdown with selectable options

• Localisation: Label and options are localisable.

Field 3: Resource Distribution Strategy

• Purpose: Select how resources will be distributed during the campaign.

• Field Type: Dropdown

• Default Value: None (user selection required)

• Mandatory: Yes

• UI Behaviour: Dropdown with filter support

• Localisation: Fully localised label and values.

1.3 Campaign Detail Validations

• All mandatory fields are marked with an asterisk (*)

• Users cannot proceed unless all required fields are filled out.

• Validation messages are configurable and localisable.

Step 2: Configure Microplan Details

The Microplan Details section captures the identity of the microplan and provides contextual visibility into the selected campaign configuration.

2.1 Campaign Details Summary

This is a read-only summary of information entered in the previous section, displayed for user confirmation:

• Campaign Disease (e.g., Malaria)

• Campaign Type (e.g., SMC Campaign)

• Resource Distribution Strategy (e.g., House-to-House)

This helps users validate campaign context before naming the microplan.

2.2 Configure Microplan Name

Field: Name of the Microplan

• Purpose: Provide a unique and identifiable name for the microplan.

• Field Type: Text Input

• Mandatory: Yes

2.3 Microplan Naming Rules

The microplan name must follow predefined validation rules:

• Length must be between 3 and 64 characters

• Name cannot contain only numeric values

• Allowed special characters: -, _, (, ), &

2.4 Naming Configuration via MDMS

Microplan naming rules and guidance are driven by MDMS masters:

• Naming Regex Controls validation logic hcm-microplanning → MicroplanNamingRegex

• Naming Convention Info Provides user-facing naming guidance hcm-microplanning → MicroplanNamingConvention

These configurations ensure consistency across all microplans.

2.5 Suggested Microplan Name

• The system auto-generates a suggested microplan name based on selected campaign details.

• Users may:

  • Accept the suggested name, or

  • Enter a custom name that satisfies validation rules

Example: Malaria-Bednet Campaign-Fixed Post & House-to-House-29 Nov 24

2.6 Localisation Support

• All field labels, helper texts, and validation messages are fully localisable

• Suggested naming instructions respect localisation settings

Step 3: Proceed to Next Configuration Steps

Once all required fields in Campaign Details and Microplan Details are valid:

• The user can proceed to the next step in the microplan creation flow

• Campaign and microplan context is locked and reused across subsequent steps

API Endpoints

Endpoint	Method	Payload
/project-factory/v1/project-type/create	POST	{ "hierarchyType": "ADMIN", "tenantId": "mz", "action": "draft", "campaignName": "test90", "resources": [], "projectType": "MR-DN", "additionalDetails": { "beneficiaryType": "INDIVIDUAL", "key": 2 }, "RequestInfo": {} }
/project-factory/v1/project-type/search	POST	{ "tenantId": "mz", "ids": [ "2a2491a7-c52d-4305-8b5b-9aa10ae44168" ], "pagination": {}, "RequestInfo": {} }
/plan-service/config/_create	POST	{ "PlanConfiguration": { "tenantId": "mz", "name": "Malaria-Bednet Campaign-Fixed Post & HDec 24", "campaignId": "52fea5b5-e7d2-424a-89ee-d167443314a9", "status": "DRAFT", "files": [], "assumptions": [], "operations": [], "resourceMapping": [], "additionalDetails": { "key": "2" } }, "RequestInfo": {} }
/plan-service/config/search	POST	{ "tenantId": "mz", "pagination": {}, "RequestInfo": {} }