1 of 7

HRMS

HRMS Employee Create-Edit UI Flow

Case: Create

URL- digit-ui/employee/hrms/create

Logged User can able to Create Employee by providing necessary Details

If a user enters a mobile number that already exists in the system - Then the application will give an error message.

The Boundary is auto-filled with current TenantId. The user is able to add Multiple Jurisdictions and Assignments.

SL No

API

ROLE

Access Id

/egov-hrms/employees/_create

HRMS_ADMIN

1750

/egov-hrms/employees/_search

HRMS_ADMIN

1752

Primary Files

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/pages/createEmployee.js

Case: Edit

URL- digit-ui/employee/hrms/edit/{Employee Id}

Logged User can able to Edit Employee Details. Employee Id is disabled.

SL No

API

Role

Access Id

/egov-hrms/employees/_update

HRMS_ADMIN

1751

Primary Files

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/pages/EditEmployee/EditForm.js

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/pages/EditEmployee/index.js

MDMS API

 moduleDetails: [
    {
      moduleName: "common-masters",
      masterDetails: [
        { name: "Department", filter: "[?(@.active == true)]" },
        { name: "Designation", filter: "[?(@.active == true)]" },
      ],
    },
    {
      moduleName: "tenant",
      masterDetails: [{ name: "tenants" }],
    },
    {
      moduleName: "ACCESSCONTROL-ROLES",
      masterDetails: [{ name: "roles", filter: "$.[?(@.code!='CITIZEN')]" }],
    },
    { moduleName: "egov-location", masterDetails: [{ name: "TenantBoundary" }] },
  ]

Employee Details UI Flow

URL- digit-ui/employee/hrms/details/{Employee Id}

Logged User should able to see details of Employee

Employment Status
Personal Details
Employee Details
Jurisdiction Details
Assignment Details

Supported Documents

If User has uploaded any Documents against Employment Status. Those Documents should be one click Downloadable

API details

SL No

API

Role

Access ID

/egov-hrms/employees/_search

HRMS_ADMIN

1752

Primary Files

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/pages/EmployeeDetails.js

Employee Activation-Deactivation UI Flow

Logged in users can activate or deactivate employees as required.

Deactivate Employee

If Employee status is Active. Users can Deactivate Employee by clicking on the Take Action button placed on Employee Detail Screen.

On the click of Deactivate Employee button, a PopUp appears where users should provide necessary details such as

Mandatory

Reason for Deactivation
Effective Date

Optional

Order No.
Supported Documents (File Upload)
Remarks

On Deactivation User will be navigated to the Acknowledgement screen

Activation Employee

If employee status is inactive, users can reactivate employees by clicking on the Take Action button placed on Employee Detail Screen.

On the click of Deactivate Employee button, a popup appears where users should provide necessary details such as

Mandatory

Reason for Reactivation
Effective Date

Optional

Order No.
Supported Documents (File Upload)
Remarks

On reactivation, users are routed to the Acknowledgement screen

SL No

API

Details

/egov-hrms/employees/_update

1 let documents = { 2 referenceType: "ACTIVATION", 3 documentId: uploadedFile, 4 documentName: file.name, 5 }; 6 applicationData.Employees[0]["documents"].push(documents); 7 } 8 9 Employees[0]["reactivationDetails"].push(data); 10 Employees[0].isActive = true;

/egov-hrms/employees/_update

1 let documents = { 2 referenceType: "DEACTIVATION", 3 documentId: uploadedFile, 4 documentName: file.name, 5 }; 6 applicationData.Employees[0]["documents"].push(documents); 7 } 8 Employees[0]["deactivationDetails"].push(data); 9 Employees[0].isActive = false; 10 history.push("/digit-ui/employee/hrms/response", { Employees, key: "UPDATE", action: "DEACTIVATION" });

Primary Files

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/EmployeeAction.js

Secondary Files

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/Modal/index.js

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/Modal/EmployeeActivation.js

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/Modal/EmployeeAppliaction.js

MDMS Hook

const { isLoading, isError, errors, data, ...rest } = Digit.Hooks.hrms.useHrmsMDMS(tenantId, "egov-hrms", "DeactivationReason");

Search Employee By Multiple Criteria UI Flow

URL - digit-ui/employee/hrms/inbox

Admin can able to search Employee bases on multiple Filters and search Parameters

Filter By

ULB
Department
Status

Name
Employee ID
Mobile Number

Has a pagination feature

On Hover of Roles Count

Logged User can able see the detail assigned roles

On click upon Employee Id Logged User are routed to Employee Detail screen

SL.No

API

Paramaters

Role

Access ID

egov-hrms/employees/_search?

tendantId
limit
orderby
offset
{Filter Params}
{Search Params}

HRMS_ADMIN

1752

Primary Files

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/pages/Inbox.js

Secondary Files

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/inbox/DesktopInbox.js

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/inbox/search.js

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/inbox/ApplicationCard.js

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/inbox/ApplicationTable.js

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/inbox/ApplicationLinks.js

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 Hrms service persister config path added in 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.

Interaction Diagram

Configuration Details

Following are the list of masters required for HRMS:

common-masters:

Department

Designation -

egov-hrms masters:

Degree -

Employee Status -

Employee Type -

Reason For Deactivation or Reactivation -

Departmental Tests -

Specialisation -

access-control masters:

egov-location masters:

persister configuration:

Localization:

Create messages to be sent on employee creation./ reactivation

Service Details

Details of all 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 does he report 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 year of passing.

Constraints:
Test details must be configured in the system.

Deactivation Details: Details of 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 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/_create should be added as the create endpoint for creating employees in the system
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
egov-hrms/employees/_update should be added as the update endpoint. This method is used to update employee details.
egov-hrms/employees/_count should be added as count API to get a list of active and inactive employees present in the system.

Reference Docs

Doc Links

API List

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

Employees Count UI Flow

Admin Can able see the Total Count of Employee's

Active Employee Count
Total Employee Count

https://github.com/egovernments/digit-ui-internals/blob/development/packages/modules/hrms/src/components/hrmscard.js

API -EndPoint

/egov-hrms/employees/_count

Role Action Mapping

SL NO

API URL

ROLES

ACTION ID

/egov-hrms/employees/_count

HRMS_ADMIN

2143

HRMS Service

Overview

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.

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.

Interaction Diagram

Configuration Details

Following are 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:

Roles -

egov-location masters:

Boundary -

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 all the entities involved:

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.

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.

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 year of passing.

Constraints:
Test details must be configured in the system.

Deactivation Details: Details of 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 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/_create should be added as the create endpoint for creating employees in the system
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
egov-hrms/employees/_update should be added as the update endpoint. This method is used to update employee details.
egov-hrms/employees/_count should be added as count API to get a list of active and inactive employees present in the system.