Health
PlatformDomainAcademyDesign SystemFeedback
v1.0
v1.0
  • Introducing DIGIT Health Platform
    • Roadmap
  • Platform
    • Release Notes
      • Release Checklist
    • Platform Features
    • Architecture
      • Master Data Management Service (MDMS)
      • High Level Design
        • Health Campaign System High Level Design
        • Design Decision Log
      • Low Level Design
        • Registries
          • Individual
          • Household
          • Product
          • Facility
        • Services
          • Project
          • Stock
    • Technical Skillset & Pre-requisites
    • Installation
      • Setup Requirements
      • Supported Clouds
    • Configuration
      • Localisation Keys
    • Development Guide
    • Source Code
    • DHIS2 to DIGIT Integration
      • DHIS2-DIGIT Field Mapping
  • Products
    • Health Campaign Management
      • Frontline Worker's App
        • User Personas
        • Features
        • User Interface Design
          • User Management
          • Complaints Management
          • Supervision Flow
          • Beneficiary Registration
          • Service Delivery
          • Inventory Management
          • User Login
        • HCM App User Manual
          • Language Selection
          • Login
          • Forgot Password
          • Project Selection
          • Beneficiary Registration
          • Delivery Intervention
          • Stock Management
          • Checklist
        • Test Cases
        • Functional Specifications
        • Field App Architecture
        • Installation
          • APK Installation
        • Configuration
          • HCM Configuration
            • Individual Registry
            • Household Registry
            • Product Registry
            • Facility Registry
            • Stock & Inventory
            • Project Services
            • Complaints
              • QA Sign-Off
                • Test Cases
            • User Management
              • QA Sign-Off
          • HCM Master Promotion Guide
        • Release Notes
          • Success Metrics
        • Product Sign-off
        • Architect Sign-off
          • Health UAT API Execution Report
          • Performance Report
        • QA Sign-off
        • Products Requirement Documents (PRDs)
          • User Management
          • Complaints Management
          • Supervision Flow
          • Role Action Mapping
          • Beneficiary Registration
          • Service Delivery
          • Inventory Management
          • User Login
      • Campaign Management Dashboard
        • Features
        • User Stories
        • User Interface Design
        • Dashboard User Manual
        • Test Cases
        • Installation
        • Configuration
          • Dashboard UI Enhancements
          • HCM Dashboard Master Promotion Guide
        • Release Notes
          • UX Audit
          • PM Audit
        • Product Sign-Off
        • Architect Sign-Off
        • QA Sign-Off
        • Product Requirement Document (PRD)
  • Programme
    • Standard Operating Procedures (SOPs) and Plans
      • SOP for Helpdesk Support
      • User Management SOP
        • Master Data Collection Template
          • Boundary Hierarchy
          • Boundary Data Specs
          • System User Setup
          • Facility
          • Product
      • Master Data Management SOP
      • Training Plan
      • Field Test Plan
      • Programme Roll-Out Plan
      • Change Management Strategy
      • UAT Plan
        • UAT 1
          • UAT 1 Test Scenarios
          • UAT Test Cases
            • Registration & Distribution
            • Inventory Flow
            • Supervision
          • User Acceptance Test Report
            • Plan Dates
        • UAT 2
          • UAT 2 SOP
          • UAT 2 Test Scenarios
          • UAT Observations
            • Registration and Distribution
            • Inventory Flow
            • Supervision
            • General Feedback
          • UAT Feedback Form: SUS
          • UAT Feedform Form: Process
    • Monitoring and Evaluation (M&E) Tools
    • Implementation Checklist
    • DIGIT Pre-Training Tutorials
Powered by GitBook

https://creativecommons.org/licenses/by/4.0/

On this page
  • Pre-requisites
  • Key Functionalities
  • Configuration Details
  • API Details

Was this helpful?

Export as PDF
  1. Products
  2. Health Campaign Management
  3. Frontline Worker's App
  4. Configuration
  5. HCM Configuration

User Management

PreviousTest CasesNextQA Sign-Off

Last updated 2 years ago

Was this helpful?

The objective of User Management is digit HRMS service to provide a service that manages all the employees enrolled in the system. HRMS provides extensive APIs to create, update and search the employees with attributes like assignments, service history, jurisdiction, etc. HRMS can be treated as a sub-set of the egov-user service, Every employee created through HRMS will also be created as a user in egov-user.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

  • Java 8

  • Kafka server is up and running

  • egov-persister service is running and has Hrms service persister config path added in it

  • PSQL server is running and a database is created to store employee data.

  • Dependency services should be up and running:

    • egov-user -

    • egov-notification-mail -

    • user-otp -

Key Functionalities

  • This service provides a feature to create, update and search the employee in the system.

  • It provides a feature to add a various role to an employee under multiple jurisdictions.

  • It provides a feature to deactivate and reactivate an employee.

  • It records the employee details like assignment details, jurisdiction details, and personal details.

Setup Details

  • In the case of IntelliJ, the plugin can be installed directly. For eclipse, the Lombok jar location has to be added in the eclipse.ini file in this format javaagent:lombok.jar.

Following are the properties in the application.properties file in hrms service which is configurable.

Property

Value

Remarks

egov.hrms.employee.app.link

https://health-dev.digit.org/employee/user/login

This is the link to the heath web app, which differs based on the environment.

egov.hrms.default.pagination.limit

200

This is the pagination limit on search results of employee search, it can be set to any numeric value without decimals.

egov.hrms.default.pwd.length

10

This is the length of password to be generated at the time of employee creation. However, please ensure this is in sync with the egov-user pwd policy.

egov.hrms.auto.generate.password

false

Password can be set while creating the user. Use false when random password generation is not required

open.search.enabled.roles

SUPERUSER,ADMIN

This is a list of Role codes that are allowed to perform an open-search in hrms.

kafka.topics.notification.sms

egov.core.notification.sms

Kafka Topic to push the sms request. Please ensure this is in sync with egov-notification-sms service.

kafka.topics.save.service

save-hrms-employee

Kafka topic to push the save request in hrms. Please ensure this in sync with the persister.

kafka.topics.update.service

update-hrms-employee

Kafka topic to push the update request in hrms. Please ensure this in sync with the persister.

egov.idgen.ack.name

hrms.employeecode

Key to be configured in Idgen alongwith the ID format to generate employee code.

egov.idgen.ack.format

EMP-[city]-[SEQ_EG_HRMS_EMP_CODE]

Format to be configured in ID gen to generate employee code.

Configuration Details

  • EmployeeDepartment.json

{
  "tenantId": "default",
  "moduleName": "egov-hrms",
  "EmployeeDepartment": [
    {
      "code": "NMCP",
      "active": true
    },
    {
      "code": "TECH",
      "active": true
    },
    {
      "code": "WAREHOUSE",
      "active": true
    },
    {
      "code": "ADM",
      "active": true
    }
  ]
}
  • Degree

{
  "tenantId": "default",
  "moduleName": "egov-hrms",
  "Degree": [
    {
      "code": "MATRICULATION",
      "active": true
    },
    {
      "code": "10+2/EQUIVALENTDIPLOMA",
      "active": true
    },
    {
      "code": "B.A/B.SC./B.COM/BBA",
      "active": true
    },
    {
      "code": "LLB/LLM",
      "active": true
    },
    {
      "code": "B.E/B.TECH.",
      "active": true
    },
    {
      "code": "M.A/M.COM./M.SC.",
      "active": true
    },
    {
      "code": "M.E/M.TECH.",
      "active": true
    },
    {
      "code": "MBA/PGDM",
      "active": true
    },
    {
      "code": "DOCTORATE",
      "active": true
    },
    {
      "code": "OTHER",
      "active": true
    }
  ]
}
  • Employee Status

{
  "tenantId": "default",
  "moduleName": "egov-hrms",
  "EmployeeStatus": [
    {
      "code": "ACTIVE",
      "active": true
    },
    {
      "code": "INACTIVE",
      "active": true
    }
  ]
}
  • Employee Type

{
  "tenantId": "default",
  "moduleName": "egov-hrms",
  "EmployeeType": [
    {
      "code": "PERMANENT",
      "active": true
    },
    {
      "code": "TEMPORARY",
      "active": true
    },
    {
      "code": "DAILYWAGES",
      "active": true
    },
    {
      "code": "CONTRACT",
      "active": true
    },
    {
      "code": "DEPUTATION",
      "active": true
    }
  ]
}
  • Reason For Deactivation or Reactivation

{
  "tenantId": "default",
  "moduleName": "egov-hrms",
  "DeactivationReason": [
    {
      "code": "OTHERS",
      "active": true
    },
    {
      "code": "ORDERBYCOMMISSIONER",
      "active": true
    }
  ]
}
  • Roles

{
  "tenantId": "default",
  "moduleName": "ACCESSCONTROL-ROLES",
  "roles": [
    {
      "code": "SYSTEM_ADMINISTRATOR",
      "name": "System Administrator",
      "description": "System Administrator"
    },
    {
      "code": "REGISTRAR",
      "name": "Registrar",
      "description": "Registrar"
    },
    {
      "code": "DISTRIBUTOR",
      "name": "Distributor",
      "description": "Distributor"
    },
    {
      "code": "SUPERUSER",
      "name": "Super User",
      "description": "Super User. Can change all master data and has access to all the system screens."
    },
    {
      "code": "NATIONAL_SUPERVISOR",
      "name": "National Supervisor",
      "description": "Supervisor who can view National health dashboard"
    },
    {
      "code": "PROVINCIAL_SUPERVISOR",
      "name": "Provincial Supervisor",
      "description": "Supervisor who can view Provincial health dashboard"
    },
    {
      "code": "DISTRICT_SUPERVISOR",
      "name": "District Supervisor",
      "description": "Supervisor who can view District health dashboard"
    },
    {
      "code": "FIELD_SUPERVISOR",
      "name": "Field Supervisor",
      "description": "Supervisor who can view Field health dashboard"
    },
    {
      "code": "SUPERVISOR",
      "name": "Supervisor",
      "description": "Supervisor"
    },
    {
      "code": "WAREHOUSE_MANAGER",
      "name": "Warehouse Manager",
      "description": "Warehouse manager"
    },
    {
      "code": "INTERNAL_MICROSERVICE_ROLE",
      "name": "Internal Microservice Role",
      "description": "Internal role for plain access"
    },
    {
      "code": "CITIZEN",
      "name": "Citizen",
      "description": "Citizen who can raise complaint"
    },
    {
      "code": "PGR-ADMIN",
      "name": "PGR Administrator",
      "description": "Admin role that has super access over the system"
    },
    {
      "code": "HRMS_ADMIN",
      "name": "HRMS Admin",
      "description": "HRMS Admin"
    },
    {
      "code": "HELPDESK_USER",
      "name": "HELPDESK USER",
      "description": "HELPDESK USER"
    },
    {
      "code": "L2_SUPPORT",
      "name": "L2 Support",
      "description": "L2 Support"
    },
    {
      "code": "CSR",
      "name": "CSR",
      "description": "CSR"
    }
  ]
}
  • Boundary

API Details

persister configuration:

Postman collection

The source code for an (egov-hrms) is present in the digit-dev Git repo. The spring boot application needs the Lombok* extension added to the IDE to load it. Once the application is up and running, the API requests can be posted to the URL and the IDs can be generated.

Refer to the Swagger API for YAML file details:

Source code
Source code
Source code
User Management
UserManagement.yaml
Click here
health-campaign-mdms/boundary-data.json at DEV · egovernments/health-campaign-mdmsGitHub
health-campaign-config/hrms-employee-persister.yml at v1.1.0 · egovernments/health-campaign-configGitHub
Logo
Logo