Microplan Details

The microplan creation process is organised into multiple steps using a stepper for better navigation. The first step in this process is Microplan Details, divided into two sections: Campaign Details and Microplan Details. This document provides an overview of these sections.

---

1. Campaign Details

The Campaign Details section collects critical information about the campaign to set up the microplan.

Header

• Title: Enter the campaign details Guides users to input required campaign information.

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

Localisation: Both the title and description are fully translatable into multiple languages.

---

Fields

1. Disease Identified for the Campaign

• Description: Select the disease targeted for the campaign.

• Field Type: Dropdown

• Default Value: Malaria

• Mandatory: Yes

• Usage: Use the dropdown or type to filter options.

Localization: The label is translatable.

2. Type of Campaign

• Description: Specify the type of campaign.

• Field Type: Dropdown

• Default Value: None (user must select a value)

• Mandatory: Yes

• Usage: Select the type from the dropdown.

Localization: The label and options are localizable.

3. Resource Distribution Strategy

• Description: Choose a strategy for distributing resources.

• Field Type: Dropdown

• Default Value: None (user must select a value)

• Mandatory: Yes

• Usage: Select a strategy aligned with campaign goals.

Localization: Fully supports translations for the label and dropdown options.

---

User Interface

• Dropdown Menu:

  • Accepts text input for filtering options.

  • Includes a dropdown arrow icon for selection.

---

Validation

• Fields marked with an asterisk (*) are mandatory.

• Users must complete all required fields to proceed.

• Validation rules and error messages are localizable.

---

2. Microplan Details

The Microplan Details section focuses on naming the microplan for reference and identification in subsequent steps.

Fields

1. Campaign Details Summary

Displays a summary of the campaign information entered:

• Campaign Disease: Malaria

• Campaign Type: SMC Campaign

• Resource Distribution Strategy: House-to-House

2. Name of the Microplan

• Description: Provide a unique name for the microplan.

• Field Type: Text Input

• Mandatory: Yes

Microplan Naming Rules

1. The name must be between 3 and 64 characters in length.

2. Numeric values alone are not allowed.

3. Allowed special characters: -, _, (, ), &.

Naming Regex MDMS: https://unified-qa.digit.org/workbench-ui/employee/workbench/mdms-search-v2?moduleName=hcm-microplanning&masterName=MicroplanNamingRegex

• Provides the regex pattern used to validate microplan names.

Naming Convention Info MDMS: https://unified-qa.digit.org/workbench-ui/employee/workbench/mdms-search-v2?moduleName=hcm-microplanning&masterName=MicroplanNamingConvention

• It contains detailed information about naming conventions and guidelines.

Suggested Name: The system automatically suggests a microplan name based on campaign details. You can use this suggested name or provide a unique name that matches the naming rules.

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

Localization: Instructions and validation messages are fully translatable.

API Endpoints and Example Request Payloads

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": {} }