User Interface Design

Below are the configurations needed for successfully setting up the microplan module:

PreviousHCM Microplan Web NextSet Up Microplan

Last updated 5 months ago

Was this helpful?

User Interface Design

Below are the configurations needed for successfully setting up the microplan module:

citymodule needed to run campaign module in an environment:Link:

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

Refer to the below ID's link in QA:

roles need to be added in rolesLink:

The following roles have been added in the MDMS:

MICROPLAN_ADMIN
ROOT_FACILITY_CATCHMENT_MAPPER
FACILITY_CATCHMENT_MAPPER
ROOT_POPULATION_DATA_APPROVER
POPULATION_DATA_APPROVER
ROOT_PLAN_ESTIMATION_APPROVER
PLAN_ESTIMATION_APPROVER

The following actions are added to the MDMS, the actions are mapped to roles using rolesactions.js

The following are the actions Idsmapped to the roles

1639 1758 1765 1914 1915 1916 1917 1918 1919 
1920 1921 1922 1923 1924 1925 1926 1927 1928 
1929 1930 1931 1932 1933 1934 1935 1936 1937 
1938 1939 1940 1941 1942 1943 1944 1945 1946 
1947 1948 1949

Link for reference:

Each of the action id is a path for a specific action

The actions are defined in

The "hcm-microplanning" module in the application leverages various master data configurations to drive the microplanning and resource distribution functionalities. These configurations are crucial for ensuring that the system adheres to the right structure and rules for microplan creation, distribution strategy, and other related operations.

Master Details for "hcm-microplanning":

The following master details are part of the hcm-microplanning module

Each of the master will access their respective master data in the mdms.

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

Description of the master details:

Microplan Naming Convention - Defines the naming structure for microplans, ensuring consistency in naming across the system.
Microplan Naming Regex - Provides a regular expression used for validating microplan naming conventions.
Resource Distribution Strategy - Describes the strategy for resource allocation, ensuring resources are distributed effectively and according to predefined rules.
Roles for Microplan - Contains data related to the roles and permissions associated with the microplan process, ensuring appropriate access control.
Hypothesis Assumptions - Defines the assumptions used in the creation of hypotheses for microplanning, guiding the analysis process.
Rule Configure Output - Contains configurations related to the output of rules, guiding how the rules should be structured and the expected results.
Rule Configure Inputs - Contains configurations for the inputs required by rules, ensuring that the correct data is fed into the rule engine.
Auto-Filled Rule Configurations - Specifies the auto-filled configurations used by the system for rules, automating parts of the rule configuration process.
Rule Configure Operators - Defines the operators used in rule configurations, specifying the operations available for rule evaluation.
Registration and Distribution Happening Together or Separately - Specifies whether registration and distribution activities occur together or separately, affecting process flow.
Hierarchy Config - Contains the configuration data for the hierarchy structure, defining different levels of hierarchy and their relationships.
Village Road Condition - Captures the road conditions in different villages, which may affect resource distribution and microplanning strategies.
Village Terrain - Describes the terrain of various villages, helping in the planning of distribution strategies based on geographical factors.
Security Questions - Specifies the set of security questions used for user authentication and verification.
Facility Type - Defines the types of facilities available within the microplanning system, ensuring proper categorization.
Facility Status - Specifies the status of various facilities (e.g., operational, under construction), which helps in planning and distribution.
Vehicle Details - Contains information on available vehicles, used for the transportation of resources within the planning scope.
Context Path for User - Defines the user-specific context, ensuring the correct path is followed within the system based on the user's role and access.
DSS KPI Configs - Defines the configurations for the Key Performance Indicators (KPIs) used by the Decision Support System (DSS), guiding decision-making processes.
HierarchySchema: Defines the order of the boundaries


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

These master details are accessed and managed via the BASE_MASTER_DATA schema code to maintain data consistency, accuracy, and facilitate smooth operations within the hcm-microplanning module.

DevOps Configuration

Localisation

Module

Use

rainmaker-common

For all common screen localisation messages like login, homepage, sidebar.

rainmaker-microplanning

For localisation messages related to microplanning and configurations.

rainmaker-boundary-${BOUNDARY_HIERARCHY_TYPE}

For boundary type localisations, using the BOUNDARY_HIERARCHY_TYPE from the MDMS.

rainmaker-Microplanning

Localisation messages for microplanning screens and related workflows.

rainmaker-workbench

Localisation messages for tools and utilities in the operational workbench.

rainmaker-mdms

Localisation messages for master data retrieved via MDMS.

rainmaker-schema

Localisation messages for schema definitions and configurations.

rainmaker-hcm-admin-schemas

Localisation messages for HCM administrative schemas and configurations.