User Management
Overview
The objective of the User Management registry in the DIGIT HRMS service is to provide a service that manages all the employees enrolled in the system. HRMS provides extensive APIs to create, update, and search employees with attributes like assignments, service history, jurisdiction, etc. HRMS can be treated as a subset 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 the 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 - Source code
egov-notification-mail - Source code
user-otp - Source code
Key Functionalities
This service provides a feature to create, update, and search employees 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 such as assignment details, jurisdiction details, and personal details.
Setup
Clone or download the code from the GitHub repository
The source code for the User Management registry is located in the Git repository here. Clone or download the code from this repository before proceeding.
API Details
Refer to the Swagger API for YAML file details: UserManagement.yaml
Application Properties
The following are the configurable properties in the application.properties file in the HRMS service.
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
Persister Configuration
Postman Collection
Last updated
Was this helpful?