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:
configs/hrms-employee-persister.yml at qa · egovernments/configs
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:
For a given period of time, an employee shouldn't have more than one assignment.
The department and designation part of the employee must be configured in the system.
Details of assignments once entered into the system cannot be deleted.
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:
The details pertaining to a jurisdiction like Hierarchy, Boundary Type, and Boundary must be configured in the system.
An employee can have more than one jurisdiction.
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:
There's no rule on period, dates of different services can overlap.
There's no cap on the number of entries in the service history.
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
Add MDMS configs required for HRMS Service and restart MDMS service.
Deploy the latest version of egov-hrms Service.
Add HRMS Service persister yaml path in persister configuration and restart persister service
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
To integrate, the host of egov-hrms-services module should be overwritten in the helm chart.
egov-hrms/employees/_createshould be added as the create endpoint for creating employees in the systemegov-hrms/employees/_searchshould be added as the search endpoint. This method handles all requests to search existing employee records depending on different search criteriaegov-hrms/employees/_updateshould be added as the update endpoint. This method is used to update employee details.egov-hrms/employees/_countshould 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
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)
Last updated
Was this helpful?