Configuration
Last updated
Last updated
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
The document guides the various configuration options available in the HCM Console. Proper configuration is crucial for optimising performance, ensuring security, and customising the user experience to meet specific needs. This document is designed to help system administrators, developers, and end-users understand and implement these configurations effectively. To learn more about HCM Service/App Configuration, Click here.
The primary audience for this document includes:
System Administrators: Responsible for setting up and maintaining the application in various environments.
Developers: Need to understand configuration options for development, testing, and deployment.
End-Users: May require guidance on configuring user-specific settings via the user interface.
This schema manages the naming conventions for microplans, ensuring uniqueness and consistency across configurations.
Module Name: hcm-microplanning
Master Name: MicroplanNamingConvention
This schema validates the naming conventions for microplans by enforcing a specific format. Each entry includes a unique ID, the regex pattern, and its active status.
Module Name: hcm-microplanning
Master Name: MicroplanNamingRegex
This schema outlines strategies for resource allocation during microplanning. Each strategy has a unique code and a descriptive name to identify it.
Module Name: hcm-microplanning
Master Name: ResourceDistributionStrategy
Defines roles and their execution order within a microplanning process. Each role is associated with a unique code and a numerical order for prioritization.
Module Name: hcm-microplanning
Master Name: rolesForMicroplan
This schema encapsulates assumptions for different campaign types, including strategies for registration and distribution processes. It also organizes assumptions into categories, with each category having specific assumptions listed.
Module Name: hcm-microplanning
Master Name: HypothesisAssumptions
Details the outputs associated with rule configurations for microplanning. Each category defines its outputs, organized by order and relevance to specific campaigns.
Module Name: hcm-microplanning
Master Name: RuleConfigureOutput
Manages the inputs required for rule configurations during microplanning. Inputs are categorized and ordered, ensuring they align with relevant campaigns and strategies.
Module Name: hcm-microplanning
Master Name: RuleConfigureInputs
This schema automates the population of rule configurations based on predefined assumptions, outputs, and inputs, streamlining microplanning efforts.
Module Name: hcm-microplanning
Master Name: AutoFilledRuleConfigurations
Defines the operators available for creating rules in microplanning. Each operator has a unique name and code to identify its functionality.
Module Name: hcm-microplanning
Master Name: RuleConfigureOperators
Specifies whether registration and distribution processes are conducted together or separately. Each configuration includes a unique code and descriptive name.
Module Name: hcm-microplanning
Master Name: RegistrationAndDistributionHappeningTogetherOrSeparately
This schema represents road conditions in villages, which is crucial for microplanning logistics. Each entry contains a unique code, a descriptive name, and its active status, indicating whether the condition is currently considered in planning.
Module Name: hcm-microplanning
Master Name: villageRoadCondition
This schema categorizes village terrains to support better planning and resource allocation. Each terrain is identified by a unique code, a descriptive name, and its active status.
Module Name: hcm-microplanning
Master Name: villageTerrain
Defines a set of security questions used for user authentication or verification. Each question has a unique numeric ID, a textual question, an array of possible values, and a flag indicating if the question is mandatory.
Module Name: hcm-microplanning
Master Name: securityQuestions
Identifies different types of facilities involved in microplanning. Each type is defined by a unique code, a name, and its active status, making it easy to manage facility-specific operations.
Module Name: hcm-microplanning
Master Name: facilityType
Tracks the operational status of facilities. Each entry includes a unique code, a descriptive name, and a flag indicating whether the status is active.
Module Name: hcm-microplanning
Master Name: facilityStatus
Details of vehicles used in microplanning logistics, including type, manufacturer, model, capacity, and unit of measurement. Unique constraints ensure no duplicates for manufacturer-model-capacity combinations. The schema also references external schemas for vehicle type and unit of measurement.
Module Name: hcm-microplanning
Master Name: VehicleDetails
Defines the various types of vehicles used in microplanning, with each type identified by a unique string.
Module Name: hcm-microplanning
Master Name: VehicleType
Manages context path configurations for users, essential for customizing their environment. Each configuration includes a unique ID and a corresponding context path.
Module Name: hcm-microplanning
Master Name: ContextPathForUser
This schema configures Key Performance Indicators (KPIs) for Decision Support Systems (DSS). Each module can have multiple KPI configurations, including campaign-specific charts with attributes such as visualization type, code, order, and hierarchy levels.
Module Name: hcm-microplanning
Master Name: DssKpiConfigs
Configures the hierarchical structure used in microplanning. Each entry specifies the hierarchy type, the lowest level in the hierarchy, and ensures uniqueness.
Module Name: hcm-microplanning
Master Name: hierarchyConfig
Defines the configuration for Units of Measure (UOM) used in the system. Each UOM is identified by a unique uomCode and is associated with a descriptivename, such as "Kilogram" or "Meter". This schema ensures UOM codes are unique and provides a standardized way to reference measurement units across the application.
Module Name: hcm-microplanning
Master Name: Uom
Configures uploaded file types in the system, uniquely identified by a code. Each entry includes details like id, iconName, and required status, along with supported file types specifying fileExtension and namingConvention. Ensures code is unique for standardized file management.
Module Name: hcm-microplanning
Master Name: UploadConfiguration
Defines the configuration for metrics in the system. Each metric is uniquely identified by a code and includes a name and an active status. Ensures uniqueness of the code for standardized metric management.
Module Name: hcm-microplanning
Master Name: Metric
Configures data schemas for hierarchical and facility-based mapping. Each schema is uniquely identified by type, campaignType, and section and includes templates, facility data mappings, and properties for visualization and rules configuration. Supports hierarchy validation and resource mapping for comprehensive data management.
Module Name: hcm-microplanning
Master Name: Schemas
Defines a schema for common constants used in configurations. Each constant is uniquely identified by its name and must include both name and value fields, which are string types. This schema ensures uniqueness and standardization for constant values across applications.
Module Name: hcm-microplanning
Master Name: CommonConstants
This schema defines hierarchy configurations for various contexts like microplanning, campaigns, and consoles. It includes details like type, associated groups, departments, and boundaries, as well as the lowest and highest hierarchy levels for each configuration.
Module Name: HCM-ADMIN-CONSOLE
Master Name: HierarchySchema
Manages custom sheet data configurations for admin consoles. Each sheet has a unique title and type, along with structured data organized as arrays of objects with column-value pairs.
Module Name: HCM-ADMIN-CONSOLE
Master Name: customSheetData
Refer here to learn more about the Helm Configurations.
