DIGIT Urban
PlatformDomainsAcademyDesign SystemFeedback
v2.7
v2.7
  • Introducing DIGIT Urban
  • Platform
    • Release Notes
      • MDMS Configuration & Service Build Updates
      • Test Cases
      • FSM Release Notes v1.1
        • FSM Service Build Updates
        • FSM MDMS Configuration Updates
        • FSM Test Cases
        • FSM Module Release Notes
      • National DSS & State DSS Release Notes
      • Birth & Death Release Notes
      • Common Features UI/UX Revamp
      • Property Tax Release Notes
    • Platform Features
    • Architecture
    • Specifications
    • Installation
      • Setup Basics
        • Setup Requirements
          • Tech Enablement Training - Essential Skills and Pre-requisites
          • Tech Enablement Training (eDCR) - Essential Skills and Prerequisites
          • DIGIT Rollout Program Governance
          • DevOps Skills Requirements
          • Infra Requirements
          • Team Composition for DIGIT Implementation
          • Infra Best Practices
          • Operational Best practices
          • Why Kubernetes for DIGIT
        • Supported Clouds
          • Google Cloud
          • Azure
          • AWS
          • VSphere
          • SDC
          • NIC
        • Deployment - Key Concepts
          • Security Practices
          • CI/CD
          • Readiness & Liveness
          • Resource Requests & Limits
        • Understanding ERP Stack
          • ERP Monolithic Architecture
          • ERP Hybrid Architecture
          • ERP Coexistence Architecture
          • APMDP-HYBRID-INFRA-ARCHITECTURE
          • eGov SmartCity eGovernance Suite
          • ERP Deployment Process
          • ERP Release Process
          • ERP User Guide
        • Deploying DIGIT Services
          • Deployment Architecture
          • Routing Traffic
          • Backbone Deployment
        • Troubleshooting
          • Distributed Tracing
          • Logging
          • Monitoring & Alerts
    • Configuration
      • Git Repos
      • Setting up Master Data
        • MDMS Overview
        • Configuring Tenants
        • Configuring Master Data
        • Adding New Master
        • State Level Vs City Level Master
      • Master Data Collection Templates
        • Environment Setup
          • State Level Setup
            • Tenants Information
            • SMS Account Configuration
            • Email Account Configuration
            • Google Play Store Account
            • Payment Gateway Configuration
            • POS Integration Configuration
            • Domain Name Configuration
            • SSL Configuration
            • ULB Departments
            • ULB Designations
            • Localization
            • Google Map Configuration
          • ULB Level Setup
            • Boundary Hierarchies
            • Boundary Data
            • Cross Hierarchy Mapping
            • ULB Bank Accounts
        • Module Setup
          • Web Portals Templates
            • State Portal
            • ULB Portal
          • HRMS Data Templates
            • User Roles
            • System Users
          • Billing And Payments Data Templates
            • Tax Heads
            • Receipt Format
            • Demand Bill Format
          • DSS Data Templates
            • KPI Acceptance
          • Workflow Data Templates
            • Workflow Actions
            • Workflow Levels
            • Workflow Process
            • Workflow Notifications
          • Common Configuration Details
            • Standard Document List
            • Service Document Mapping
            • Checklist
            • Configuring Data FAQs
      • Configuring DIGIT Service Stack
        • Core Services
          • Workflow Services
          • Location Services
          • User Services
          • Access Control Services
          • PDF Generation Service
          • MDMS (Master Data Management Service)
          • Payment Gateway Service
          • NLP Engine Service
          • User Session Management In DIGIT
          • Indexer Service
          • URL Shortening Service
          • XState Core Chatbot
            • XState-Chatbot Integration Document
            • Xstate-Chatbot Message Localisation
        • Business Service
          • Appropriation Service
          • Billing Service
            • Bill Amendment Service Configuration
          • Collection Service
            • Collection Service Migration
            • Collection Service V2
          • Billing Collection Integration
          • Dashboard Analytics - Backend
            • DSS Features Enhancements
            • DSS Dashboard - Technical Document for UI
            • DSS Technical Documentation
          • Technical Script/Steps For Migration Process
        • Municipal Service
          • Turn-Io-Adapter
          • Inbox Service
        • Utilities
      • Configuring Services
        • Persister Configuration
        • Indexer Configuration
        • Setting up a Language
          • Adding New Language
          • Setting Up Default Language For SMS & Emails
        • API Checklist
        • Setting Up SMS Gateway
          • Using The Generic GET & POST SMS Gateway Interface
        • Setting Up Service Locally
        • Configuring Workflows
          • Setting Up Workflows
          • Configuring Workflows For An Entity
          • Workflow Auto Escalation
        • DSS Configuration And Setup
          • Building New Dashboards
        • Configuring New Reports
          • Types Of Reports Used In Report Service
          • Impact Of Heavy Reports On Platform
        • Adding Roles To System
        • Mapping Roles With APIs
        • Deployment Of App on Play Store
        • Adding New APIs For Access
        • FileStore Service
        • Telemetry Service
        • Report Service
        • ID Generation Service
        • Localization Service
        • Email Notification Service
        • SMS Notification Service
        • SMS Template Approval Process
        • Searcher Service
        • Zuul Service
        • User OTP Service
        • eGov OTP Service
        • Persister Service
        • Encryption Service
        • Document Uploader Service
        • Notification Enhancement Based on Different Channels
        • Configuring Localization
          • Setup Base Product Localization
          • Configure SMS and Email
        • DIGIT: Internal Datamart Deployment Steps
        • Customizing PDF Notices And Certificates
          • Integration Of PDF In UI For Download And Print PDF
          • Customizing PDF Receipts & Certificates
      • QA Automation
        • Kafka Consumer Producer Approach
        • Jenkins Setup for Automation
        • Automation Framework Knowledge Base
          • Automation Test Tags
          • Automation Test Reporting
        • State-Level UI Customization
      • Configuration FAQs
    • Customization
      • Frontend/UI
      • DIGIT Customization
        • API Do's & Don'ts
        • Writing A New Customer
        • Enhancing Existing Service
  • Products
    • Products & Modules
      • Trade Licence (TL)
        • TL Brochure
        • TL Module Functional Specifications
        • TL Implementation Guide
        • TL Master Data Templates
          • Trade Type
          • Trade Sub Type
          • Trade Category
          • Trade License Fee
          • Structure Type
          • Structure Sub Type
          • Trade License Document Attachment
        • TL Service Configuration
          • Trade License Calculator
          • TL Apply Flow UI Details
            • My Applications UI Flow
            • Send Back - Edit UI Flow
            • Trade License Renewal UI Flow
            • Employee Inbox UI Details
            • Employee Search Application Search License UI Flow
            • New Trade License UI Flow
            • Application Details - Trade Details UI Flows
            • Renew Edit Application
        • TL User Manual
          • TL Citizen User Manual
          • TL Employee User Manual
        • TL Demo Script
      • Property Tax (PT)
        • PT Brochure
        • PT Module Functional Specifications
        • PT Implementation Guide
        • PT Master Data Templates
          • Mutation Fee
          • Rebate Rates
          • Penalty Rates
          • Interest Rates
          • Tax Rates
          • Unit Rates
          • Special Category Documents
          • Owner Special Category
          • Ownership Sub Category
          • Ownership Category
          • Usage Category Detail
          • Road Type
          • Construction Type
          • Property Type
          • Property Sub Type
          • Usage Category Major
          • Usage Category Minor
          • Usage Category Sub Minor
        • PT Service Configuration
          • Property Mutation & Mutation Calculator
          • PT Update Number & Alternate Number
            • Update Primary Mobile Number & Alternate Mobile Number
          • Assessment of Property
          • PT Calculator
          • Fuzzy Search
            • Fuzzy Search Reindexing
          • Common PT
          • PT - Create Property UI Details
            • Edit-Update Property
            • Property Tax - My Applications
            • Property Tax - My Properties
            • Property Tax - Search Applications
            • Property Tax - Quick Pay for Citizen
            • Property Tax - Search And Pay My Bills
            • Property Tax - My Payments
            • Create Application - Employee UI/UX Revamp
            • Employee Edit Application Flow
            • Employee - Search Property, Property Details Page & Assessment
            • Employee - Inbox & Application Details
            • Employee Inbox (Old UI)
            • Citizen Mutation Flow
            • Employee - Mutation (Ownership Transfer)
          • PT Data Migration
        • PT User Manual
          • PT Citizen User Manual
          • PT Employee User Manual
      • Water & Sewerage (W&S)
        • W&S Brochure
        • W&S Module Functional Specifications
        • W&S Implementation Guide
        • Water Service Configuration
          • Legacy/Re-Indexing the Water & Sewerage Service
          • State DSS - Water & Sewerage
          • Water Calculator Service
          • Sewerage Service Configuration
            • Sewerage Calculator Service
        • Sewerage Charges Master Data Templates
          • Sewerage Rates
          • Sewerage Penalty Rates
          • Sewerage Interest Rates
        • Water Charges Master Data Templates
          • Water Rates (Metered)
          • Pipe Size Types
          • Water Source Types
          • Water Rates (Non-Metered)
          • Water Penalty Rates
          • Water Interest Rates
        • W&S User Manual
          • W&S Citizen User Manual
          • W&S Employee User Manual
      • Public Grievances & Redressal (PGR)
        • PGR Brochure
        • PGR Module Functional Specifications
        • PGR Workflows
        • PGR Master Data Templates
          • Grievance Type
          • Grievance Sub Type
          • Routing Matrix
          • Escalation Matrix
        • PGR Service Configuration
          • PGR Migration
        • PGR User Manual
          • Complaint Types List
          • PGR Citizen User Manual
          • PGR Employee User Manual
        • PGR Demo Script
      • Online Building Plan Approval System (OBPAS)
        • OBPAS Brochure
        • OBPAS Module Functional Specifications
        • OBPAS Implementation Guide
        • OBPAS Master Data Templates
          • Fee Structure
          • NOC Departments
          • Stakeholders Type
          • List Of Services
          • Service-Wise Documents
          • Building Occupancy
          • Building Sub Occupancy
          • Building Usage
          • Inspection Checklist
          • Town Planning Schemes
        • OBPAS Service Configuration
          • BPA Service Configuration
          • BPA Stakeholder Registration
          • Legacy/Re-Indexing For OBPS
          • BPA Calculator Service
          • Setting Up eDCR Service
          • eDCR Integration
          • Noc Services
          • Land Services
          • State DSS - OBPS
          • OBPAS DIGIT UI
            • Stakeholder - Registration Flow
            • OBPS-BPA/OC-BPA Employee Flow
              • OBPS Inbox
              • OBPS Search Application
            • OBPS-BPA/OC-BPA Architect
            • OBPS EDCR /OC-EDCR
            • OBPS BPA / OCBPA Citizen
            • Employee - Stakeholder
              • Stakeholder Inbox
              • Stakeholder Search Application
        • OBPAS User Manual
          • OBPAS Citizen User Manual
          • OBPAS Employee User Manual
        • OBPAS Demo Script
      • mCollect (MCS)
        • MCS Functional Specifications
        • mCollect Master Data Templates
          • Service Category
          • Service Sub Category
          • Service Sub Category GL Code Mapping
        • MCS Service Configuration
          • e-Challan Service
            • e-Challan Calculator Service
          • Re-Indexing The mCollect Service
          • State DSS - mCollect
          • Current Bill Cancellation UI Flow
            • Bill Details UI Flow
            • Cancel Bill UI Flow
          • Receipt Cancellation UI Flow
            • View Receipt - Cancel UI Flow
          • e-Challan UI Details
            • Edit - Cancel Challan
            • Search and Pay Challan
            • mCollect UI Flow
            • Update - Cancel Challan UI Flow
            • Challan Creation
        • mCollect User Manual
          • MCS Citizen User Manual
          • MCS Employee User Manual
      • Faecal Sludge Management (FSM)
      • Finance
        • Finance Module Functional Specifications
        • Finance Implementation Guide
        • Finance Master Data Templates
          • Bank Account
          • Chart Of Accounts
          • Funds
          • Function
          • Contractors
          • Suppliers
          • Schemes
          • Sub Schemes
          • Banks
          • Bank Branch
          • Deduction
          • Opening Balances
          • Sub Ledger Category
          • Sub Ledger Master
        • Finance Service Configuration
          • Finance Collections Voucher Consumer Service
        • Finance User Manual
          • Finance Employee User Manual
          • Admin User Manual
          • Finance Reports Manual
      • Fire NOC
        • Fire NOC Functional Specifications
        • Fire NOC Master Data Templates
          • Building Usage Type
          • Building Sub Usage Type
          • Fire Station Master
          • Areas Served Master
          • Fire Station Mapping
          • Fire NOC Fee
        • Fire NOC Service
          • Re-Indexing the Fire NOC Service
          • State DSS - Fire NOC
          • Fire NOC Calculator Service
          • NOC DIGIT UI
            • NOC Inbox
            • Application Overview
        • Fire NOC User Manual
          • Fire NOC Citizen User Manual
          • Fire NOC Employee User Manual
      • HRMS
        • HRMS Functional Specifications
        • HRMS Employee Create-Edit UI Flow
        • Employee Details UI Flow
        • Employee Activation-Deactivation UI Flow
        • Search Employee By Multiple Criteria UI Flow
        • HRMS Service
        • Employees Count UI Flow
        • Auto Escalation UI Flow
      • Events And Notifications
        • User Events Services
        • Citizen Flow
        • Employee Flow - Events
        • Employee Flow - Messages
      • Citizen Engagement Module
        • Document Uploader Service
        • Documents: Implementation Details
      • Common UI Docs
        • User Profile
          • Citizen Profile
          • Employee Profile
          • Employee City Change
        • Update Number & Invalid Number
        • Troubleshoot Using Browser Network Tab
      • Birth & Death
        • Birth & Death User Manual
          • Birth & Death Citizen User Manual
          • Birth & Death Employee User Manual
        • Birth & Death Service Configuration
          • State DSS - Birth and Death
          • Birth & Death Service Setup
      • National Urban Real-Time Dashboard
        • National Urban Dashboard User Manual
        • National Urban Dashboard Functional Specifications
        • National Dashboard Service Configuration
          • National Dashboard - UI Technical Doc
          • DSS UI Flow
          • W&S - National Dashboard
          • Property Tax - National Dashboard
          • Fire NOC - State DSS
          • National Dashboard - Overview
          • National Urban Realtime Dashboard
          • Trade License - National Dashboard
          • OBPS - National Dashboard
          • PGR - National Dashboard
          • National Dashboard Ingest Service
          • National Dashboard API Performance Testing and Benchmark
          • National Dashboard: Index Creation Steps
          • mCollect National Dashboard
      • Product FAQs
    • Training Resources
      • Training Videos
      • Technical Enablement Areas
      • eDCR Training Plan
    • Partner Support
      • eGov Enablement Support for DIGIT
      • Security Guidelines Handbook
      • Troubleshooting Guide
  • ๐Ÿ›ƒEcosystem
    • DIGIT Pre-Sales Toolkit
      • Infra Calculator
      • Resource Calculator
      • DIGIT Services
    • Access DIGIT
    • Urban Docs Guide
    • Roadmap
    • Open Events
    • Source Code
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
  • Overview
  • Pre-requisites
  • Key Functionalities
  • Interaction Diagram
  • Configuration Details
  • Service Details
  • Deployment Details
  • Integration Details
  • Integration Scope
  • Integration Benefits
  • Steps to Integration
  • Reference Docs
  • Doc Links
  • API List

Was this helpful?

Edit on GitHub
Export as PDF
  1. Products
  2. Products & Modules
  3. HRMS

HRMS Service

Overview

The objective of HRMS is 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 is added as a user in the 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 the HRMS service persister config path added to it

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

Key Functionalities

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

  • It provides a feature to add various roles 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.

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

Property

Value

Remarks

egov.hrms.employee.app.link

This is the link to the mseva 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.

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.

Interaction Diagram

Configuration Details

Following is the list of masters required for HRMS:

common-masters:

  • Department

{
  "tenantId": "state",
  "moduleName": "common-masters",
  "Department": [
    {
      "name": "Street Lights",
      "code": "DEPT_1",
      "active": true
    },
    {
      "name": "Building & Roads",
      "code": "DEPT_2",
      "active": true
    },
    {
      "name": "Health & Sanitation",
      "code": "DEPT_3",
      "active": true
    },
    {
      "name": "Operation & Maintenance",
      "code": "DEPT_4",
      "active": true
    },
    {
      "name": "Horticulture",
      "code": "DEPT_5",
      "active": true
    },
    {
      "name": "Building Branch",
      "code": "DEPT_6",
      "active": true
    },
    {
      "name": "Citizen service desk",
      "code": "DEPT_7",
      "active": true
    },
    {
      "name": "Complaint Cell",
      "code": "DEPT_8",
      "active": true
    },
    {
      "name": "Executive Branch",
      "code": "DEPT_9",
      "active": true
    },
    {
      "name": "Others",
      "code": "DEPT_10",
      "active": true
    },
    {
      "name": "Tax Branch",
      "code": "DEPT_13",
      "active": true
    },
    {
      "name": "Accounts Branch",
      "code": "DEPT_25",
      "active": true
    },
    {
      "name": "Works Branch",
      "code": "DEPT_35",
      "active": true
    }
  ]
}
  • Designation -

{
  "tenantId": "state",
  "moduleName": "common-masters",
  "Designation": [
    {
      "code": "DESIG_01",
      "name": "Superintending Engineer ( B&R)",
      "description": "Superintending Engineer ( B&R)",
      "active": true
    },
    {
      "code": "DESIG_02",
      "name": "Corporation Engineer (B&R)",
      "description": "Corporation Engineer (B&R)",
      "active": true
    },
    {
      "code": "DESIG_03",
      "name": "Asst. Engineer ( B&R)",
      "description": "Asst. Engineer ( B&R)",
      "active": true
    },
    {
      "code": "DESIG_04",
      "name": "Junior Engineer ( B&R)",
      "description": "Junior Engineer ( B&R)",
      "active": true
    },
    {
      "code": "DESIG_05",
      "name": "Land Scape Officer",
      "description": "Land Scape Officer",
      "active": true
    },
    {
      "code": "DESIG_06",
      "name": "Superintending Engineer ( O&M)",
      "description": "Superintending Engineer ( O&M)",
      "active": true
    },
    {
      "code": "DESIG_07",
      "name": "Corporation Engineer (O&M)",
      "description": "Corporation Engineer (O&M)",
      "active": true
    },
    {
      "code": "DESIG_08",
      "name": "Asst. Engineer ( O&M)",
      "description": "Asst. Engineer ( O&M)",
      "active": true
    },
    {
      "code": "DESIG_09",
      "name": "Junior Engineer ( O&M)",
      "description": "Junior Engineer ( O&M)",
      "active": true
    },
    {
      "code": "DESIG_10",
      "name": "Superintending Engineer ( Light)",
      "description": "Superintending Engineer ( Light)",
      "active": true
    },
    {
      "code": "DESIG_11",
      "name": "Corporation Engineer (Light)",
      "description": "Corporation Engineer (Light)",
      "active": true
    },
    {
      "code": "DESIG_12",
      "name": "Junior Engineer ( Light)",
      "description": "Junior Engineer ( Light)",
      "active": true
    },
    {
      "code": "DESIG_13",
      "name": "Health Officer",
      "description": "Health Officer",
      "active": true
    },
    {
      "code": "DESIG_14",
      "name": "Medical Officer",
      "description": "Medical Officer",
      "active": true
    },
    {
      "code": "DESIG_15",
      "name": "Chief Sanitary Inspector",
      "description": "Mechanical Oversear",
      "active": true
    },
    {
      "code": "DESIG_16",
      "name": "Sainitary Inspector",
      "description": "Clerk",
      "active": true
    },
    {
      "code": "DESIG_17",
      "name": "Sainitary Supervisor",
      "description": "Accountant",
      "active": true
    },
    {
      "code": "DESIG_18",
      "name": "Senior Town Planner",
      "description": "Senior Town Planner",
      "active": true
    },
    {
      "code": "DESIG_19",
      "name": "Municipal Town Planner",
      "description": "Municipal Town Planner",
      "active": true
    },
    {
      "code": "DESIG_20",
      "name": "Asst. Town Planner",
      "description": "Asst. Town Planner",
      "active": true
    },
    {
      "code": "DESIG_21",
      "name": "Building Inspector",
      "description": "Building Inspector",
      "active": true
    },
    {
      "code": "DESIG_22",
      "name": "Junior Enginer ( Horticulutre)",
      "description": "Junior Enginer ( Horticulutre)",
      "active": true
    },
    {
      "code": "DESIG_23",
      "name": "Citizen service representative",
      "description": "Citizen service representative",
      "active": true
    },
    {
      "name": "Deputy Controller Finance and Accounts",
      "description": "Deputy Controller Finance and Accounts",
      "code": "DESIG_1001",
      "active": true
    },
   {
      "name": "Accountant",
      "description": "Accountant",
      "code": "DESIG_58",
      "active": true
    },
   {
      "code": "DESIG_24",
      "name": "Assistant Commissioner",
      "description": "Assistant Commissioner",
      "active": true
    },    
    {
      "name": "Superintendent",
      "description": "Superintendent",
      "code": "DESIG_47",
      "active": true
    }
  ]
}

egov-hrms masters:

  • Degree -

{
  "tenantId": "state",
  "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": "state",
  "moduleName": "egov-hrms",
  "EmployeeStatus": [
    {
      "code": "EMPLOYED",
      "active": true
    },
    {
      "code": "RETIRED",
      "active": true
    },
    {
      "code": "RESIGNED",
      "active": true
    },
    {
      "code": "TERMINATED",
      "active": true
    },
    {
      "code": "DECEASED",
      "active": true
    },
    {
      "code": "SUSPENDED",
      "active": true
    },
    {
      "code": "TRANSFERRED",
      "active": true
    }
  ]
}
  • Employee Type -

{
  "tenantId": "state",
  "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": "state",
  "moduleName": "egov-hrms",
  "DeactivationReason": [
    {
      "code": "OTHERS",
      "active": true
    },
    {
      "code": "ORDERBYCOMMISSIONER",
      "active": true
    }
  ]
}
  • Departmental Tests -

{
  "tenantId": "state",
  "moduleName": "egov-hrms",
  "EmploymentTest": [
    {
      "code": "PRELIMS",
      "active": true
    },
    {
      "code": "APTITUDETEST",
      "active": true
    },
    {
      "code": "MAINS",
      "active": true
    }
  ]
} 
  • Specialisation -

{
  "tenantId": "state",
  "moduleName": "egov-hrms",
  "Specalization": [
    {
      "code": "ARTS",
      "active": true
    },
    {
      "code": "SCIENCE",
      "active": true
    }
  ]
}

access-control masters:

egov-location masters:

persister configuration:

Localization:

Create messages to be sent on employee creation./ reactivation

{
  "messages": [
    {
      "code": "hrms.employee.create.notification",
      "message": "Hi $employeename, Welcome to mSeva. Your profile has been successfully set-up : Username - $username Password - $password Visit your profile at $applink, Thank you.",
      "module": "egov-hrms",
      "locale": "en_IN"
    },
    {
            "code": "hrms.employee.reactivation.notification",
            "message": "Dear <Employee Name>,\nYour profile with employee Username <Username> has been activated on <date>. Your one-time password is <password>. Please change your password using the link below\n<link>",
            "module": "egov-hrms",
            "locale": "en_IN"
    }
  ]
}

Service Details

Details of the entities involved

Assignments: Every employee is assigned a list of assignments, every assignment is a designation provided to that employee for a given period of time. These designations are mapped to departments. This also includes marking the employee as HOD for that department if needed. An employee can also provide information on who he reports to.

  • Constraints:

    1. For a given period of time, an employee shouldn't have more than one assignment.

    2. The department and designation part of the employee must be configured in the system.

    3. Details of assignments once entered into the system cannot be deleted.

    4. An employee cannot have more than one active assignment.

Jurisdictions: A jurisdiction is an area of power for any employee. It can be a zone, ward, block, city, state, or country. Currently, jurisdiction is defined as a combination of Hierarchy type, Boundary Type, and the actual Boundary. However, in the current system, we are not validating these jurisdictions. This is being collected only for the sake of data.

  • Constraints:

    1. The details pertaining to a jurisdiction like Hierarchy, Boundary Type, and Boundary must be configured in the system.

    2. An employee can have more than one jurisdiction.

    3. Currently in the system jurisdiction is limited to within a ULB.

Service History: Service history is the record of an employee's professional experience. It captures information about the location and period of work with the necessary order number. Information about the current work details is to be entered here.

  • Constraints:

    1. There's no rule on period, dates of different services can overlap.

    2. There's no cap on the number of entries in the service history.

    3. Captured as legacy data.

Educational Details: Captures educational details of the employee. Captures information like Degree, Year of Passing, University, Specialization, etc as part of the educational details.

  • Constraints:

    Details pertaining to educational details like Degree, Specialization must be configured.

Departmental Tests: Captures details of the tests undertaken by the employee. Like the name of the test and the year of passing.

  • Constraints:

    Test details must be configured in the system.

Deactivation Details: Details of the deactivation of the employee, which captures the reason for deactivation, period of deactivation, and other necessary details.

  • Constraints:

    Deactivation details are compulsory while deactivating an employee.

Reactivation Details: Details of reactivation of the employee, which captures the reason for reactivation, the effective date from when reactivation takes place, and other necessary details.

  • Constraints:

    Reactivation details are compulsory while reactivating an employee.

Uniqueness Constraints:

  • Employee code has to be unique and will be used as a username for login.

  • The phone number has to be unique, which means no 2 employees can have the same phone number.

Notification:

  • Notification is sent to the phone number of the employee who has been created in the system. This is an SMS notification.

Deployment Details

  1. Add MDMS configs required for HRMS Service and restart MDMS service.

  2. Deploy the latest version of egov-hrms Service.

  3. Add HRMS Service persister yaml path in persister configuration and restart persister service

  4. Add role-action mapping for APIs.

Integration Details

Integration Scope

The egov-hrms service is used to manage all the employees enrolled in the system. It is used to assign roles under multiple jurisdictions.

Integration Benefits

  • Can create an employee with a specific role to assign it to a particular module.

  • Can add any role to an employee across multiple jurisdictions.

  • Provide a feature to deactivate and reactivate an employee.

Steps to Integration

  1. To integrate, the host of egov-hrms-services module should be overwritten in the helm chart.

  2. egov-hrms/employees/_create should be added as the create endpoint for creating employees in the system

  3. egov-hrms/employees/_search should be added as the search endpoint. This method handles all requests to search existing employee records depending on different search criteria

  4. egov-hrms/employees/_update should be added as the update endpoint. This method is used to update employee details.

  5. egov-hrms/employees/_count should be added as a count API to get a list of active and inactive employees present in the system.

Reference Docs

Doc Links

Title

Link

API Swagger Documentation

API List

Title

Link

egov-hrms/employees/_create

egov-hrms/employees/_update

egov-hrms/employees/_search

egov-hrms/employees/_count

(Note: All the APIs are in the same postman collection therefore the same link is added in each row)

PreviousSearch Employee By Multiple Criteria UI FlowNextEmployees Count UI Flow

Last updated 2 years ago

Was this helpful?

Roles -

Boundary -

https://raw.githubusercontent.com/egovernments/egov-mdms-data/master/data/pb/ACCESSCONTROL-ROLES/roles.json
https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/amritsar/egov-location/boundary-data.json
https://dev.digit.org/employee/user/login
Swagger Documentation
https://www.getpostman.com/collections/c9d8ae63a10fac6fdd43
https://www.getpostman.com/collections/c9d8ae63a10fac6fdd43
https://www.getpostman.com/collections/c9d8ae63a10fac6fdd43
https://www.getpostman.com/collections/c9d8ae63a10fac6fdd43
configs/hrms-employee-persister.yml at qa ยท egovernments/configs