DIGIT Docs
Microplanning 0.1
  • DIGIT Knowledge Base
  • Local Governance
Microplanning 0.1
  • Introducing Microplanning
    • Release Notes
      • v0.1 Release Notes
        • Release Checklist
        • Technical Release Summary
        • Master Data Management Service (MDMS) and Configuration updates
        • Service Builds
        • UI/UX Audit
  • PRODUCT SPECIFICATION
    • User Manual
    • Product Requirement Document
      • SOPs
        • Guidelines
  • TECHNOLOGY
    • Architecture
      • High Level Design
      • Low Level Design
        • Plan Management
        • Census Management
        • Microplanning UI
          • System Admin Flow
          • Population Data Approval
          • Facility Catchment Mapping
          • Microplan Estimation Approval
      • Services
        • HCM Microplan Web
          • User Interface Design
          • Set Up Microplan
            • Microplan Details
            • Boundary Selection
            • Data Management
            • Microplan Assumptions
            • Formula Configuration
            • User Tagging
            • Summary Screen
          • User Management
            • Bulk User Create
            • Download Users Credentials
          • Supervisor Flows
            • User Interface Design
            • My Microplan
            • Select Activity
            • Validate And Approve Population Data
              • Village Details
            • Assign Facility To Villages
              • Village Assignment And Unassignment to Facility
            • Validate And Approve Microplan Estimation
          • Open Microplans: System Admin
    • Specification
      • Plan Service
      • Resource Generator Service
      • Census Service
  • SETUP
    • Installation
    • Configuration
      • Advanced Configurations
    • QA Test Cases
Powered by GitBook

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

Export as PDF
  1. TECHNOLOGY
  2. Architecture
  3. Services
  4. HCM Microplan Web
  5. Set Up Microplan

Boundary Selection

PreviousMicroplan DetailsNextData Management

Last updated 5 months ago

Was this helpful?

The Boundary Selection step is the second step in the microplan creation process. It allows users to define the geographic areas (boundaries) where the campaign will be conducted. Users must select boundaries at different hierarchical levels to ensure accurate targeting.


Header

  • Title: Select the boundaries where you want to run the campaign Provides clear instructions for selecting the geographic regions for the campaign.

  • Description: Boundaries are the administrative areas defined that you want to run a campaign in. Start selecting boundaries from the first level so that the boundaries present in the next level are available for selection. Explains the importance of hierarchical boundary selection.

  • Localization: Both the title and description can be translated into multiple languages.


Fields

The following fields represent the hierarchical administrative levels for boundary selection. These levels are dynamic and depend on the hierarchy definition configured in the system. An example hierarchy could look like this:

  1. Country

    • Description: Select the top-level boundary (e.g., Country) where the campaign will be conducted.

    • Field Type: Dropdown

    • Mandatory: Yes

    • Usage: Selection of this level enables the next level in the hierarchy.

  2. Province

    • Description: Select the second-level boundary (e.g., Province) within the chosen country.

    • Field Type: Dropdown

    • Mandatory: Yes

    • Usage: Available only after selecting the country.

  3. District

    • Description: Select the third-level boundary (e.g., District) within the chosen province.

    • Field Type: Dropdown

    • Mandatory: Yes

    • Usage: Available only after selecting the province.

  4. Administrative Post

    • Description: Select the next boundary level (e.g., Administrative Post) within the chosen district.

    • Field Type: Dropdown

    • Mandatory: Yes

    • Usage: Available only after selecting the district.

  5. Locality

    • Description: Select the locality boundary within the chosen administrative post.

    • Field Type: Dropdown

    • Mandatory: Yes

    • Usage: Available only after selecting the administrative post.

  6. Village

    • Description: Select the final-level boundary (e.g., Village) within the chosen locality.

    • Field Type: Dropdown

    • Mandatory: Yes

    • Usage: Available only after selecting the locality.

Note: The hierarchy structure (e.g., Country > Province > District > Administrative Post > Locality > Village) is just an example. Actual levels and labels will vary based on the specific administrative hierarchy configured in the system.


Key Points

  • The number of levels and their labels (e.g., Country, Province, District) are not fixed and depend on the system's hierarchy definition.

  • Users must proceed sequentially, selecting each level to unlock the next.

  • Localization: All hierarchy level labels are fully translatable, allowing them to be displayed in different languages as required.


User Interface

  • Dropdown Menu:

    • Hierarchical: The options in each dropdown depend on the selection made in the previous level.

    • Filtering: Text input is supported to filter options.

  • Validation: Ensures selections are made sequentially and that no level is skipped.

  • Localization: Error messages and validation prompts are fully translatable.


Validation Rules

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

  • Users cannot proceed without completing the selection at each level.

  • If boundaries are not selected down to the last level, or if any selected boundary does not have its child boundary selected, a proper error message is displayed.


Boundary Selection Overview Card

The Boundary Selection Overview Card displays details of the number of selected levels at each dynamically configured boundary level (e.g., Country, Province, District, etc.). It provides a quick summary of the selections made at each level, offering users an efficient way to track the progress of the boundary selection process.

API Endpoints and Example Request Payloads

It looks like the second update was missed. Here's the table with both updates correctly included:

Endpoint
Method
Payload

/boundary-service/boundary-relationships/_search

POST

{ "tenantId": "mz", "hierarchyType": "MICROPLAN", "includeChildren": true, "RequestInfo": {} }

/boundary-service/boundary-hierarchy-definition/_search

POST

{ "BoundaryTypeHierarchySearchCriteria": { "tenantId": "mz", "limit": 1, "offset": 0, "hierarchyType": "MICROPLAN" }, "RequestInfo": {} }

/project-factory/v1/project-type/search

POST

{ "CampaignDetails" : { "tenantId": "mz", "ids": [ "730fb389-5e60-4c43-b6ce-b1c109b23f54" ]}, "RequestInfo": {} }

/plan-service/config/_search

POST

{ "PlanConfigurationSearchCriteria": { "tenantId": "mz", "id": "660fb389-5e60-4c43-b6ce-b1c109b23f54" } ,"RequestInfo": {} }

/project-factory/v1/project-type/update

POST

{ "CampaignDetails":{"id":"8c413d61-c411-4c33-b6eb-76ea005a84c9","tenantId":"mz","status":"drafted","action":"draft","campaignNumber":"CMP-2024-12-03-006616","isActive":true,"parentId":null,"campaignName":"Malaria-Bednet Campaign-Fixed Popp0099","projectType":"LLIN-mz","hierarchyType":"MICROPLAN","boundaryCode":"MICROPLAN_MO","projectId":null,"startDate":1735810905674,"endDate":0,"additionalDetails":{"source":"microplan","disease":"MALARIA","resourceDistributionStrategy":"MIXED"},"resources":[],"boundaries":[],"deliveryRules":[],"auditDetails":{"createdBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","lastModifiedBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","createdTime":1733218905816,"lastModifiedTime":1733218919304}},"RequestInfo":{}}

/plan-service/config/_update

POST

`{"PlanConfiguration":{"id":"660fb389-5e60-4c43-b6ce-b1c109b23f54","tenantId":"mz","name":"Malaria-Bednet Campaign-Fixed Popp0099","campaignId":"8c413d61-c411-4c33-b6eb-76ea005a84c9","status":"DRAFT","files":[],"assumptions":[],"operations":[],"resourceMapping":[],"auditDetails":{"createdBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","lastModifiedBy":"f4f36858-0e9e-4150-a37f-444b90995e7c","createdTime":1733218906001,"lastModifiedTime":1733218924572},"additionalDetails":{"key":"2"},"workflow":null},"RequestInfo": {} }