Muster Roll

Muster Roll UI Tech Documentation

Overview

This module helps in processing muster rolls through the workflow. Muster rolls created in the SHG app are redirected to the web interface for workflow approval.

This module has 5 associated screens :

1. Inbox

2. Edit

3. View

4. Search

Configurations

Module Enablement Configuration

Set module code as "AttendenceMgmt" in Module.js of AttendenceMgmt Module. Refer https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/tenant/citymodule.json

{
            "module": "AttendenceMgmt",
            "code": "AttendenceMgmt",
            "active": true,
            "order": 4,
            "tenants": [
                {
                    "code": "statea.citytwo"
                },
                {
                    "code": "statea.citythree"
                },
                {
                    "code": "statea.cityone"
                }
            ]
}

Enable Module in App.js. Update the object ‘enabledModules’. Use the code “AttendenceMgmt”. This code should match the code of the cityModule.json, mentioned above.

Role-action Mapping

#	API	Action ID	Roles
2	/muster-roll/v1/_search	37	MUSTER_ROLL_VERIFIER,MUSTER_ROLL_APPROVER
3	/muster-roll/v1/_update	38	MUSTER_ROLL_VERIFIER,MUSTER_ROLL_APPROVER
5	/egov-pdf/download/musterRoll/muster-roll	104	MUSTER_ROLL_APPROVER,MUSTER_ROLL_VERIFIER
6	/egov-hrms/employees/_search	4	EMPLOYEE_COMMON
7	/expense-calculator/v1/_estimate	108	MUSTER_ROLL_APPROVER,MUSTER_ROLL_VERIFIER
8	/inbox/v2/_search	65	EMPLOYEE_COMMON

Sidebar Configuration

#	Screen	Navigation URL	Left Icon Updates	Roles
1	Muster Roll Search	/works-ui/employee/attendencemgmt/search-attendance	dynamic:AttendanceIcon	MUSTER_ROLL_APPROVER,MUSTER_ROLL_VERIFIER
2	Muster Roll Inbox	/works-ui/employee/attendencemgmt/inbox	dynamic:AttendanceIcon	EMPLOYEE_COMMON

{
      "id": 59,
      "name": "ATTENDENCEMGMT",
      "url": "url",
      "displayName": "ATTENDENCEMGMT Inbox",
      "orderNumber": 2,
      "parentModule": "",
      "enabled": true,
      "serviceCode": "ATTENDENCEMGMT",
      "code": "null",
      "navigationURL": "/works-ui/employee/attendencemgmt/inbox",
      "path": "4ATTENDENCEMGMT.Inbox",
      "leftIcon": "dynamic:AttendanceIcon"
}

Screen Configuration

#	Screen	Configuration
1	Search	https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/commonMuktaUiConfig/SearchContractConfig.json
2	Inbox	https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/commonMuktaUiConfig/InboxConfigContracts.json

Localization Configuration & Modules

TenantID	Module
statea	rainmaker-attendencemgmt

Workflow Configuration

UI Component Name	Business Service
WorkflowActions	MR

Customization

1. API-based Data -

   • The amountTotal Wage Amount - Amount shown in the view muster roll screen is fetched from expense-calculator

2. Inbox / Search Screen -

   • Please use the common utility “preProcessMDMSConfigInboxSearch”.

   • Pass the associated dependencies for the config.

   • The utility will return a config that will run through RenderFormFields.

   • Refer to docs for Pre-Process config in Component comments.