1 of 13

Drafts

Work in Progress Will be formatted and removed

Contracts

Add Module MDMS (Master Data Management Service) Configuration

When creating a Contracts module, the module needs to be enabled in citymodule.json.Add the Following details in citymodule.json

{
    "tenantId": "pb",
    "moduleName": "tenant",
    "citymodule": [
        {
            "module": "Contracts",
            "code": "Contracts",
            "active": true,
            "order": 1,
            "tenants": [
                {
                    "code": "pb.jalandhar"
                },
                {
                    "code": "pb.nawanshahr"
                },
                {
                    "code": "pb.amritsar"
                }
            ]
        }
}

Create Contract

Create Contract will have link to create contract from view approved estimate sub Estimate table screen.

Clicking on this will open create contract screen.

Add create contract fields mdms config

Add the following MDMS config to fetch the values of different dropdown filed of create estimate

MDMS config for Depatment, Designation
{
    tenant,   //pb
    "common-masters",
        [
            {
                "name": "Department"
            },
            {
                "name": "Designation"
            }
        ]
}

Once the above details are filled, user needs to forward contract to concerned department and official for checking. Forwarding is considered as part of contract creation.Fill in the details and click “Forward and Approve”.

Once Create Contract API call is successful, an acknowledgement screen is shown.

Some of the dropdown data is fetched from mdms and hrms search API

PageComponent

Data Source

API / MDMS Object

Executing Department

MDMS

{

tenant,

"common-masters",

[ { "name": "Department" } ]

}

Designation

MDMS

{

tenant,

"common-masters",

[ { "name": "Designation" } ]

}

Designation of officer in charge

hrms

/egov-hrms/employees/_search

Name of officer in charge

hrms

/egov-hrms/employees/_search

Localization keys are added under the ‘rainmaker-works’ locale module. In future if any new labels are implemented in works module that should also be pushed in the locale DB under rainmaker-works locale module. Below is the example of few locale labels for hindi and English.

{
    "code":"WORKS_CREATE_CONTRACT",
    "message":"एक अनुबंध बनाएं",
    "module":"rainmaker-works",
    "locale":"hi_IN"
}

{
    "code":"WORKS_CREATE_CONTRACT",
    "message":"Create a Contract",
    "module":"rainmaker-works",
    "locale":"en_IN"
}

Contract Workflow

User should be able to create → Forward (or) check → Forward/Reject a contract.

Contracts will be created by contract_creator, Checked by contract_checker and approver by contract_approver. This will be linear workflow and rejected contracts at any point in lifecycle will come into inbox of creator.
Contracts counters on Home Screen will increase/decrease as the inbox items for checkers and approvers increase/decrease respectively.
Actions menu on view page of Work orders should have actions to be taken by respective Actors
For Work Orders (Non-Departmental)
1. WO is created by JE, Approved by ME. Checkers in between depends on Implementation and can vary from ULB to ULB
2. Approved WO goes into Work Order inbox of respective organisation.
3. Organisation can either accept or reject.
4. Rejected Work Orders will come back into inbox of creator and cycle repeats
For Work Orders (Departmental)
1. WO is created by JE, Approved by ME. Checkers in between depends on Implementation and can vary from ULB to ULB
2. Approved WO goes into Work Order inbox of respective organisation.
3. Organisation can either accept or reject.
4. Rejected Work Orders will come back into inbox of creator and cycle repeats
For Purchase Orders
1. PO is created by JE, Approved by ME. Checkers in between depends on Implementation and can vary from ULB to ULB. An Infra expert can be assigned to check PO.
2. Approved PO goes as SMS to registered Vendor
3. Vendor can click on the PO link & download approved PO’s PDF.

Once the Estimate are created they will move to the respective checker and approver's inbox as pending items.

View Contract

From Contract Proposal Inbox, User can come into Contract View Screen where Details of Contract present while creating the contract and Workflow history will be displayed.
User can take necessary actions by clicking on Actions Menu.

Taking Actions on Contract

An Action bar on the View Contract Screen shows the list of actions

Forward Contract
Reject Contract
Modify Contract
Approve Contract

When any action is clicked respective popup is rendered according to the selected action. We have created three popups for approve, forward and reject. They are shown below

When these popups are submitted, Update Contract API is called containing the relevant updates in the workflow object contained in the request body. The contract service internally calls the workflow service and updates the status of the application.

Response Screen

Upon successful update, a response screen is displayed as follows

Modify Contract

Contract Creator should be able to edit rejected contracts and resubmit them .

Rejected Contracts will show up in contract creators inbox.
Clicking on it will take to contract view screen. Users Click on “Actions” to make changes to contract.
Contract Details, ID, Contract Type and Project Details wont be editable.
Financial Details, Agreement Details are editable.
Creator Can make these changes and proceed to forward to checker.

Clicking on Rejected Contract ID from inbox will open Contract view page.

Clicking Actions-> Modify Contract will make page editable

From here on the flow is same as that of Create Contract. Once this Contract is submitted it is again moved to the respective Checker's inbox for approval. Contract can be rejected any number of times due to any specific reason which can be mentioned in the comments and the same comments are reflected in the View Contract screen.

Upon Successful update relevant acknowledgement screen displayed.

A contract that is approved and sent to next stage wont be editable.

Estimate

Overview

An estimate proposal is the simplest form of estimate that is created to start detailing the scope and financial aspects of a project.

An estimate proposal contains

Administrative details (Department, Work type, Work Category etc)
Financial Details (Fund, Function, Budget heads COA etc)
Work Details (Name of the work, estimated amount)
Processing details (Approving department, Approver designation)

Create Estimate

Create an Estimate Proposal

Add Module MDMS (Master Data Management Service) Configuration

When creating a works module, the module needs to be enabled in citymodule.json.Add the Following details in citymodule.json

{
    "tenantId": "pb",
    "moduleName": "tenant",
    "citymodule": [
        {
            "module": "Works",
            "code": "Works",
            "active": true,
            "order": 1,
            "tenants": [
                {
                    "code": "pb.jalandhar"
                },
                {
                    "code": "pb.nawanshahr"
                },
                {
                    "code": "pb.amritsar"
                }
            ]
        }
}

Estimate Creator will have link to create estimate from estimate inbox screen.

Clicking on this will open create estimate screen.

Add create Estimate mdms config

Add the following MDMS config to fetch the values of different dropdown filed of create estimate

MDMS config for Depatment
{
    tenant,   //pb
    "common-masters",
        [
            {
                "name": "Department"
            }
        ]
}

MDMS config for Beneficiary Type, Entrustment Mode, Nature Of Work, Type Of Work
{
     tenant,    //pb
        "works",
        [
            {
                "name": "BeneficiaryType"
            },
            {
                "name": "EntrustmentMode"
            },
            {
                "name": "NatureOfWork"
            },
            {
                "name": "TypeOfWork"
            },
        ]
}

MDMS config for Scheme, Budget Head, Functions, Fund
{
    tenant,
        "finance",
        [
            {
                "name": "Scheme"
            },
            {
                "name": "BudgetHead"
            },
            {
                "name": "Functions"
            },
            {
                "name": "Fund"
            }
        ]
}

MDMS config for location
{
    tenantId,  //pb.amritsar || pb.jalandhar etc.
        "egov-location",
        [
            {
                "name": "TenantBoundary"
            },
        ]
}

Once the above details are filled, user needs to forward estimate to concerned department and official for checking. Forwarding is considered as part of estimate creation.Fill in the details and click “Forward Estimate”.

Each Work detail will be referred to as Sub-Estimate & sub Estimate will back track to all details of Estimate as-is. At least 1 Sub-Estimate has to be created to create an Estimate. Sum of All Amounts of Sub-Estimates is the Estimate Amount.

Once Create Estimate API call is successful, an acknowledgement screen is shown.

API Call Roll action-mapping

API

Action Id

Roles

/estimate-service/estimate/v1/_create

EST_CREATOR

Sample Curl for Create API

jcurl 'https://works-dev.digit.org/estimate-service/estimate/v1/_create' \
  -H 'authority: works-dev.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://works-dev.digit.org' \
  -H 'referer: https://works-dev.digit.org/works-ui/employee/works/create-estimate' \
  -H 'sec-ch-ua: "Google Chrome";v="107", "Chromium";v="107", "Not=A?Brand";v="24"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Linux"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36' \
  --data-raw '{
        "estimate": {
            "tenantId":"pb.amritsar",
            "status":"ACTIVE",
            "estimateStatus":"ACTIVE",
            "subject":"Construct new schools",
            "requirementNumber":"78960",
            "description":"Construct new schools",
            "department":"DEPT_3",
            "location":"pb.amritsar:ADMIN:pb.amritsar:Z1:B3:SUN08",
            "workCategory":"Engineering",
            "beneficiaryType":"Minority",
            "natureOfWork":"Operation & Maintenance",
            "typeOfWork":"Road",
            "subTypeOfWork":"RD02",
            "entrustmentMode":"Nomination",
            "fund":"01",
            "function":"0006",
            "budgetHead":"02",
            "scheme":"AMRUT",
            "subScheme":"AMRUT-01",
            "estimateDetails":[{
                "name":"Amrut Yojana",
                "amount":"90876"
            }],
            "additionalDetails":{
            "formData":{},
            "createdBy":"Est Super User",
            "owner":"Est Super User",
            },
        "workflow":{
            "action":"CREATE",
            "comment":"",
            "assignees":["88bd1b70-dd6d-45f7-bcf7-5aa7a6fae7d9"]
        },
        "RequestInfo":{
            "apiId":"Rainmaker",
            "authToken":"153c3161-55ce-4485-96fa-f67ea9757eea",
            "userInfo":{
                "id":110,
                "uuid":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
                "userName":"EST_SUPER",
                "name":"Est Super User",
                "mobileNumber":"9876543210",
                "emailId":"",
                "locale":null,
                "type":"EMPLOYEE",
                "roles":[{
                    "name":"Employee",
                    "code":"EMPLOYEE",
                    "tenantId":"pb.amritsar"
                    },{
                    "name":"EST CREATOR",
                    "code":"EST_CREATOR",
                    "tenantId":"pb.amritsar"
                }],
                "active":true,
                "tenantId":"pb.amritsar",
                "permanentCity":null
            },
        "msgId":"1667826119526|en_IN",
        "plainAccessRequest":{}
        }
    }'

Some of the dropdown data is fetched from mdms and hrms search API

PageComponent

Data Source

API

Executing Department

mdms

{

tenant,

"common-masters",

[ { "name": "Department" } ]

}

Ward, Location

mdms

{

"pb.amritsar",

"egov-location",

[ { "name": "TenantBoundary" }]

}

Beneficiary, Nature of Work, Type of Work

mdms

{

"pb,

"works",

[ { "name": "BeneficiaryType" },

{ "name": "EntrustmentMode" },

{ "name": "NatureOfWork" },

{ "name": "TypeOfWork" }, ]

}

Fund, Function, Budget Head,Scheme, subSchem

mdms

{

"pb",

"finance",

[ { "name": "BudgetHead" },

{ "name": "Functions" },

{ "name": "Fund" },

{ "name": "Scheme"} ]

}

Designation of officer in charge

hrms

/egov-hrms/employees/_search

Name of officer in charge

hrms

/egov-hrms/employees/_search

{
    "code":"ACTION_TEST_CREATE_ESTIMATE",
    "message":"अनुमान बनाएँ",
    "module":"rainmaker-works",
    "locale":"hi_IN"
}

{
    "code":"ACTION_TEST_CREATE_ESTIMATE",
    "message":"Create Estimate",
    "module":"rainmaker-works",
    "locale":"en_IN"
}

Roles - Action

Role

Actions

Creator (EST_CREATOR)

Create/Edit(Rejected) Estimate and Forawrded

Checket1 (EST_CHECKER)

Checked Estimate and Forwarded

Checker2 (EST_TECH_SANC)

Checked Estimate and Forwarded

Admin Approver (EST_ADMIN_SANC)

Approved Estimate

Estimate Worflow

User should be able to create → Forward (or) check → Forward/Reject an estimate.

Once the Estimate are created they will move to the respective checker and approver's inbox as pending items.

View Estimate

From Estimate Proposal Inbox, User can come into Estimate View Screen where Details of Estimate present while creating the estimate and Workflow history will be displayed.
User can take necessary actions by clicking on Actions Menu.

Sample ProcessInstance Worflow Object as given below:

{
    "RequestInfo": {
        "apiId": "estimate-service",
        "action": "",
        "did": 1,
        "key": "",
        "msgId": "20170310130900|en_IN",
        "requesterId": "",
        "ts": 1513579888683,
        "ver": "1.0.0",
        "authToken": "94ecb06f-8e5b-4798-af8f-56a987560209",
        "userInfo":{
            "uuid":"7e46e32c-187c-4fb4-9d6b-1ac70fa8f011"
        }
    },
    "BusinessServices": [
        {
            "tenantId": "pb",
            "businessService": "estimate-approval-2",
            "business": "estimate-service",
            "businessServiceSla": 432000000,
            "states": [
                {
                    "sla": null,
                    "state": null,
                    "applicationStatus": null,
                    "docUploadRequired": false,
                    "isStartState": true,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "CREATE",
                            "nextState": "CREATED",
                            "roles": [
                                "EST_CREATOR"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "CREATED",
                    "applicationStatus": "CREATED",
                    "docUploadRequired": false,
                    "isStartState": true,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "CHECK",
                            "nextState": "CHECKED",
                            "roles": [
                                "EST_CHECKER"
                            ]
                        },
                        {
                            "action": "REJECT",
                            "nextState": "REJECTED",
                            "roles": [
                                "EST_CHECKER"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "CHECKED",
                    "applicationStatus": "CHECKED",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "TECHNICALSANCATION",
                            "nextState": "TECHNICALSANCATIONDONE",
                            "roles": [
                                "EST_TECH_SANC"
                            ]
                        },
                        {
                            "action": "REJECT",
                            "nextState": "REJECTED",
                            "roles": [
                                "EST_TECH_SANC"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "TECHNICALSANCATIONDONE",
                    "applicationStatus": "TECHNICALSANCATIONDONE",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "ADMINSANCTION",
                            "nextState": "APPROVED",
                            "roles": [
                                "EST_ADMIN_SANC"
                            ]
                        },
                        {
                            "action": "REJECT",
                            "nextState": "REJECTED",
                            "roles": [
                                "EST_ADMIN_SANC"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "REJECTED",
                    "applicationStatus": "REJECTED",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "EDIT",
                            "nextState": "CREATED",
                            "roles": [
                                "EST_CREATOR"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "APPROVED",
                    "applicationStatus": "APPROVED",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": true,
                    "isStateUpdatable": false,
                    "actions": null
                }
            ]
        }
    ]
}

Sample Curl to fetch ProcessInstance

curl 'https://works-dev.digit.org/estimate-service/estimate/v1/_search?tenantId=pb.amritsar&department=DEPT_1&typeofwork=Road&fromProposalDate=1667241000000&toProposalDate=1667845799000&limit=10&sortBy=department&sortOrder=DESC&_=1667829358481' \
  -H 'authority: works-dev.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://works-dev.digit.org' \
  -H 'referer: https://works-dev.digit.org/works-ui/employee/works/search-Estimate' \
  -H 'sec-ch-ua: "Google Chrome";v="107", "Chromium";v="107", "Not=A?Brand";v="24"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Linux"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36' \
  --data-raw '{
    "RequestInfo":{
      "apiId":"Rainmaker",
      "authToken":"153c3161-55ce-4485-96fa-f67ea9757eea",
      "msgId":"1667829358480|en_IN",
      "plainAccessRequest":{}
    }
  }'

Taking Actions on Estimate

An Action bar on the View Estimate Screen shows the list of actions

Forward Estimate
Reject Estimate
Modify Estimate
Approve Estimate

When any action is clicked respective popup is rendered according to the selected action. We have created three popups for approve, forward and reject. They are shown below

When these popups are submitted, Update Estimate API is called containing the relevant updates in the workflow object contained in request body. Estimate service internally calls the workflow service and updates the status of application.

Sample curl for Update Estimate

curl 'http://localhost:3000/estimate-service/estimate/v1/_update' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Accept-Language: en-US,en;q=0.9' \
  -H 'Connection: keep-alive' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'Origin: http://localhost:3000' \
  -H 'Referer: http://localhost:3000/works-ui/employee/works/view-estimate?tenantId=pb.amritsar&estimateNumber=EP/2022-23/11/000143&department=DEPT_1' \
  -H 'Sec-Fetch-Dest: empty' \
  -H 'Sec-Fetch-Mode: cors' \
  -H 'Sec-Fetch-Site: same-origin' \
  -H 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36' \
  -H 'sec-ch-ua: "Google Chrome";v="107", "Chromium";v="107", "Not=A?Brand";v="24"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Linux"' \
  --data-raw '{
      "estimate":{
          "id":"e9d1e26c-7231-4fad-97f0-297dab173c23",
          "tenantId":"pb.amritsar",
          "estimateNumber":"EP/2022-23/11/000143",
          "adminSanctionNumber":null,
          "proposalDate":1667824800917,
          "status":"ACTIVE",
          "estimateStatus":"CREATED",
          "subject":"Construct new schools",
          "requirementNumber":"88888999",
          "description":"Construct new schools",
          "department":"DEPT_1",
          "location":"pb.amritsar:ADMIN:pb.amritsar:Z1:B2:SUN40",
          "workCategory":"Engineering",
          "beneficiaryType":"SC",
          "natureOfWork":"Operation & Maintenance",
          "typeOfWork":"Road",
          "subTypeOfWork":"RD01",
          "entrustmentMode":"e-Procurement",
          "fund":"02",
          "function":"0003",
          "budgetHead":"03",
          "scheme":"AMRUT",
          "subScheme":"AMRUT-01",
          "totalAmount":null,
          "estimateDetails":[{
              "id":"4cbef8e4-aa3c-4c93-a954-a94f04ea8c96",
              "estimateDetailNumber":"EP/2022-23/11/000143/000124",
              "name":"Amrut Yojana",
              "amount":98760,
              "additionalDetails":null
          }],
          "auditDetails":{
              "createdBy":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
              "lastModifiedBy":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
              "createdTime":1667824800916,
              "lastModifiedTime":1667824800916
          },
          "additionalDetails":{
              "owner":"Est Super User",
              "formData":{},
              "createdBy":"Est Super User",
              "filesAttached":[]
          }
      },
      "workflow":{
              "action":"CHECK",
              "comment":"Okay",
              "assignees":["c8d0093a-4d2b-495f-8bdf-fd9d3594e43f"]
      },
      "RequestInfo":{
              "apiId":"Rainmaker",
              "authToken":"153c3161-55ce-4485-96fa-f67ea9757eea",
              "userInfo":{
                  "id":110,
                  "uuid":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
                  "userName":"EST_SUPER",
                  "name":"Est Super User",
                  "mobileNumber":"9876543210",
                  "emailId":"",
                  "locale":null,
                  "type":"EMPLOYEE",
                  "roles":[
                      {
                      "name":"Employee",
                      "code":"EMPLOYEE",
                      "tenantId":"pb.amritsar"
                      },{
                      "name":"EST_CHECKER",
                      "code":"EST_CHECKER",
                      "tenantId":"pb.amritsar"
                      },{
                      "name":"EST TECH SANC",
                      "code":"EST_TECH_SANC",
                      "tenantId":"pb.amritsar"
                      },{
                      "name":"EST FIN SANC",
                      "code":"EST_FIN_SANC",
                      "tenantId":"pb.amritsar"
                      }
                  ],
                  "active":true,
                  "tenantId":"pb.amritsar",
                  "permanentCity":null
              },
          "msgId":"1667833964561|en_IN","plainAccessRequest":{}
      }
      }'

Users must have the respective roles for taking actions on the Estimate, Otherwise the Action Bar will not be visible. And users can only take actions on the applications assigned to them.

Response Screen

Upon successful update a response screen is displayed as follows

Role-Action Mapping

Role

Action

EST_CHECKER

CHECK (Check and Forward) / REJECT

EST_TECH_SANC

TECHNICALSANCTION (Check and Forward) / REJECT

EST_ADMIN_SANC

ADMINSANCTION (Approve) / REJECT

Modify Estimate

Modify Estimate and Re-Submit Estimate

An Estimate proposal that is rejected by any user in the workflow will reach creators inbox.
Creator has to make necessary changes and resubmit the Proposal
A Rejected Proposal will have status as Rejected in Creators Inbox.

Clicking on Estimate ID from inbox will open estimates view page.

Clicking Actions-> Modify Estimate will make page editable

Except Date of Proposal everything will be editable. Estimate Proposal ID which is generated initially shown in modify screen.

From here on the flow is same as that of Create Estimate. Once this Estimate is submitted it is again moved to the respective Checker's inbox for approval. Estimate can be rejected any number of times due to any specific reason which can be mentioned in the comments and the same comments are reflected in the View Estimate screen.

Upon Successful update relevant acknowledgement screen displayed.

An Estimate that is approved and sent to next stage wont be editable.

Attendance Management

Describes a group of individuals and their attendance details.

Inbox

Inbox screen for Attendance Management Module

Overview:

Lists all the musters submitted by SHG
To search/filter the muster list based on various criteria
To navigate to Muster details/View Attendance page

Workflow Details

The employee home screen will have a link to navigate to the Attendance Inbox screen

The inbox screen consists of a list of muster rolls created/submitted by SHG in tabular format. This table supports pagination and the number of records displayed per page can be editable

A minimum of 1 search criterion is required based on which the list will be populated with search results. Search parameters are as below:

Name of the work
Implementing Agency/Partner

This list can be filtered based on below parameters:

Date range
Muster roll status

A ‘No results found’ message is displayed if no records are found for the given search/filter criteria.

Both search and filter criteria can be cleared using the ‘Clear Search’ and ‘refresh’ buttons respectively. Muster Roll ID is a clickable link that navigates the user to the View Attendance screen (Muster Details).

Technical Implementation Details

Inbox screen technical implementation can be found in the file below.

Hooks used

To fetch inbox details, ‘useCustomAPIHook’ is used which takes all the API details like URL, query params and body from config (defined in MDMS).

To fetch inbox config, ‘useCustomMDMS’ hook is used which takes the module name, master details and config.

APIs used

Endpoint:

Sample curl for Inbox API:

MDMS Used

Inbox screen config is fetched from MDMS using 'useCustomMDMS' hook.

Localisation

Localisation keys are added under the ‘rainmaker-attendencemgmt’ locale module. In future, if any new labels are implemented in the attendance module they should be pushed to the locale DB under rainmaker-attendencemgmt locale module. Below is an example of a few locale labels for Hindi and English.

Customisation

The content on this screen is rendered based on configuration passed via MDMS. Its implementation can be found in the below file.

API Role Action Mapping

View Attendance

Screen to view muster roll details for selected muster roll.

Objective:

To view weekly muster roll details/attendance for selected muster roll
To view the workflow history of the muster roll

Workflow Details

Users can navigate to this screen by clicking on the muster roll id on the inbox page

The view screen consists of register details on top, Enrolled user details in tabular format, Workflow history and Actions that can be performed on selected muster. Initially, muster has ‘Submitted’ status.

Technical Implementation Details

View Attendance screen technical implementation can be found in the below file.

Hooks used

To fetch muster roll details, ‘useViewAttendance’ is used which takes tenant id and muster roll number.

To fetch workflow details, ‘useWorkflowDetails is used which takes tenant id, muster roll number, and business service (muster-roll-approval) as module code and config.

APIs used

Endpoint:

Sample curl for Search muster API:

MDMS Used

Wage seeker skills data is fetched from MDMS using 'getMultipleTypesWithFilter' service.

Localisation

Localisation keys are added under the ‘rainmaker-attendencemgmt’ locale module. In future, if any new labels are implemented in the attendance module they should also be pushed in the locale DB under rainmaker-attendencemgmt locale module. Below is an example of a few locale labels for Hindi and English.

Customisation

The content on this screen is rendered based on the configuration passed on ApplicationDetails template component. Its implementation can be found in the below file.

API Role Action Mapping

Modify Attendance

Screen to update muster roll status based on different roles

Objective: To view and modify the attendance days and perform various actions like verify, reject and approve based on roles.

Workflow Details

Users can navigate to this screen by clicking on the muster roll id on the inbox page.

Initially, the muster has 'Submitted' status. Junior Engineer can view, Edit, Verify and Reject the Attendance.

Verify: Clicking on the ‘Verify’ action button verifies the existing muster and the user is redirected to the success page
Edit: Clicking on the ‘Edit’ action button displays the extra details in the table. The working days can be edited. Based on that ‘Modified Amount’ is updated dynamically.
As soon as the user updates anything ‘Action’ button changes to the ‘Save’ button. On click of Save, muster is verified with updated details and the user is redirected to the success page.
Reject: Clicking on the ‘Reject’ action displays a popup where the user can provide any comments and reject the muster.
On 'Confirm Reject', muster will be rejected and the user will be redirected to the success page.

The municipal Engineer can view, Approve, and Reject the attendance which is verified by Junior Engineer

Approve: Clicking on the ‘Approve action displays a popup where the user can provide any comments and approve the muster.
On 'Approve Attendance', the muster will be approved and the user will be redirected to the success page.
The municipal Engineer can also reject the attendance verified by Jr Engineer by clicking on the 'Reject' action.

Technical Implementation Details

Modify attendance technical implementation where all actions are handled can be found in the below file.

Hooks used

To update muster (modify, verify, reject, approve, resubmit), ‘useUpdateAttendance’ is used which updated muster roll details.

APIs used

Endpoint:

Sample curl for Update muster API:

MDMS Used

Wage seeker skills data is fetched from MDMS using 'getMultipleTypesWithFilter' service.

Localisation

Customisation

The content on this screen is rendered based on the configuration passed on ApplicationDetails template component. Its implementation can be found in the below file.

API Role Action Mapping

Create Estimate

Create an Estimate Proposal

Add Module MDMS (Master Data Management Service) Configuration

When creating a works module, the module needs to be enabled in citymodule.json.Add the Following details in citymodule.json

{
    "tenantId": "pb",
    "moduleName": "tenant",
    "citymodule": [
        {
            "module": "Works",
            "code": "Works",
            "active": true,
            "order": 1,
            "tenants": [
                {
                    "code": "pb.jalandhar"
                },
                {
                    "code": "pb.nawanshahr"
                },
                {
                    "code": "pb.amritsar"
                }
            ]
        }
}

Estimate Creator will have link to create estimate from estimate inbox screen.

Clicking on this will open create estimate screen.

Add create Estimate mdms config

Add the following MDMS config to fetch the values of different dropdown filed of create estimate

MDMS config for Depatment
{
    tenant,   //pb
    "common-masters",
        [
            {
                "name": "Department"
            }
        ]
}

MDMS config for Beneficiary Type, Entrustment Mode, Nature Of Work, Type Of Work
{
     tenant,    //pb
        "works",
        [
            {
                "name": "BeneficiaryType"
            },
            {
                "name": "EntrustmentMode"
            },
            {
                "name": "NatureOfWork"
            },
            {
                "name": "TypeOfWork"
            },
        ]
}

MDMS config for Scheme, Budget Head, Functions, Fund
{
    tenant,
        "finance",
        [
            {
                "name": "Scheme"
            },
            {
                "name": "BudgetHead"
            },
            {
                "name": "Functions"
            },
            {
                "name": "Fund"
            }
        ]
}

MDMS config for location
{
    tenantId,  //pb.amritsar || pb.jalandhar etc.
        "egov-location",
        [
            {
                "name": "TenantBoundary"
            },
        ]
}

Once Create Estimate API call is successful, an acknowledgement screen is shown.

API Call Roll action-mapping

API

Action Id

Roles

/estimate-service/estimate/v1/_create

EST_CREATOR

Sample Curl for Create API

jcurl 'https://works-dev.digit.org/estimate-service/estimate/v1/_create' \
  -H 'authority: works-dev.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://works-dev.digit.org' \
  -H 'referer: https://works-dev.digit.org/works-ui/employee/works/create-estimate' \
  -H 'sec-ch-ua: "Google Chrome";v="107", "Chromium";v="107", "Not=A?Brand";v="24"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Linux"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36' \
  --data-raw '{
        "estimate": {
            "tenantId":"pb.amritsar",
            "status":"ACTIVE",
            "estimateStatus":"ACTIVE",
            "subject":"Construct new schools",
            "requirementNumber":"78960",
            "description":"Construct new schools",
            "department":"DEPT_3",
            "location":"pb.amritsar:ADMIN:pb.amritsar:Z1:B3:SUN08",
            "workCategory":"Engineering",
            "beneficiaryType":"Minority",
            "natureOfWork":"Operation & Maintenance",
            "typeOfWork":"Road",
            "subTypeOfWork":"RD02",
            "entrustmentMode":"Nomination",
            "fund":"01",
            "function":"0006",
            "budgetHead":"02",
            "scheme":"AMRUT",
            "subScheme":"AMRUT-01",
            "estimateDetails":[{
                "name":"Amrut Yojana",
                "amount":"90876"
            }],
            "additionalDetails":{
            "formData":{},
            "createdBy":"Est Super User",
            "owner":"Est Super User",
            },
        "workflow":{
            "action":"CREATE",
            "comment":"",
            "assignees":["88bd1b70-dd6d-45f7-bcf7-5aa7a6fae7d9"]
        },
        "RequestInfo":{
            "apiId":"Rainmaker",
            "authToken":"153c3161-55ce-4485-96fa-f67ea9757eea",
            "userInfo":{
                "id":110,
                "uuid":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
                "userName":"EST_SUPER",
                "name":"Est Super User",
                "mobileNumber":"9876543210",
                "emailId":"",
                "locale":null,
                "type":"EMPLOYEE",
                "roles":[{
                    "name":"Employee",
                    "code":"EMPLOYEE",
                    "tenantId":"pb.amritsar"
                    },{
                    "name":"EST CREATOR",
                    "code":"EST_CREATOR",
                    "tenantId":"pb.amritsar"
                }],
                "active":true,
                "tenantId":"pb.amritsar",
                "permanentCity":null
            },
        "msgId":"1667826119526|en_IN",
        "plainAccessRequest":{}
        }
    }'

Some of the dropdown data is fetched from mdms and hrms search API

PageComponent

Data Source

API

Executing Department

mdms

{

tenant,

"common-masters",

[ { "name": "Department" } ]

}

Ward, Location

mdms

{

"pb.amritsar",

"egov-location",

[ { "name": "TenantBoundary" }]

}

Beneficiary, Nature of Work, Type of Work

mdms

{

"pb,

"works",

[ { "name": "BeneficiaryType" },

{ "name": "EntrustmentMode" },

{ "name": "NatureOfWork" },

{ "name": "TypeOfWork" }, ]

}

Fund, Function, Budget Head,Scheme, subSchem

mdms

{

"pb",

"finance",

[ { "name": "BudgetHead" },

{ "name": "Functions" },

{ "name": "Fund" },

{ "name": "Scheme"} ]

}

Designation of officer in charge

hrms

/egov-hrms/employees/_search

Name of officer in charge

hrms

/egov-hrms/employees/_search

{
    "code":"ACTION_TEST_CREATE_ESTIMATE",
    "message":"अनुमान बनाएँ",
    "module":"rainmaker-works",
    "locale":"hi_IN"
}

{
    "code":"ACTION_TEST_CREATE_ESTIMATE",
    "message":"Create Estimate",
    "module":"rainmaker-works",
    "locale":"en_IN"
}

Roles - Action

Role

Actions

Creator (EST_CREATOR)

Create/Edit(Rejected) Estimate and Forawrded

Checket1 (EST_CHECKER)

Checked Estimate and Forwarded

Checker2 (EST_TECH_SANC)

Checked Estimate and Forwarded

Admin Approver (EST_ADMIN_SANC)

Approved Estimate

Estimate Worflow

User should be able to create → Forward (or) check → Forward/Reject an estimate.

Once the Estimate are created they will move to the respective checker and approver's inbox as pending items.

View Estimate

From Estimate Proposal Inbox, User can come into Estimate View Screen where Details of Estimate present while creating the estimate and Workflow history will be displayed.
User can take necessary actions by clicking on Actions Menu.

Sample ProcessInstance Worflow Object as given below:

{
    "RequestInfo": {
        "apiId": "estimate-service",
        "action": "",
        "did": 1,
        "key": "",
        "msgId": "20170310130900|en_IN",
        "requesterId": "",
        "ts": 1513579888683,
        "ver": "1.0.0",
        "authToken": "94ecb06f-8e5b-4798-af8f-56a987560209",
        "userInfo":{
            "uuid":"7e46e32c-187c-4fb4-9d6b-1ac70fa8f011"
        }
    },
    "BusinessServices": [
        {
            "tenantId": "pb",
            "businessService": "estimate-approval-2",
            "business": "estimate-service",
            "businessServiceSla": 432000000,
            "states": [
                {
                    "sla": null,
                    "state": null,
                    "applicationStatus": null,
                    "docUploadRequired": false,
                    "isStartState": true,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "CREATE",
                            "nextState": "CREATED",
                            "roles": [
                                "EST_CREATOR"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "CREATED",
                    "applicationStatus": "CREATED",
                    "docUploadRequired": false,
                    "isStartState": true,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "CHECK",
                            "nextState": "CHECKED",
                            "roles": [
                                "EST_CHECKER"
                            ]
                        },
                        {
                            "action": "REJECT",
                            "nextState": "REJECTED",
                            "roles": [
                                "EST_CHECKER"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "CHECKED",
                    "applicationStatus": "CHECKED",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "TECHNICALSANCATION",
                            "nextState": "TECHNICALSANCATIONDONE",
                            "roles": [
                                "EST_TECH_SANC"
                            ]
                        },
                        {
                            "action": "REJECT",
                            "nextState": "REJECTED",
                            "roles": [
                                "EST_TECH_SANC"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "TECHNICALSANCATIONDONE",
                    "applicationStatus": "TECHNICALSANCATIONDONE",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "ADMINSANCTION",
                            "nextState": "APPROVED",
                            "roles": [
                                "EST_ADMIN_SANC"
                            ]
                        },
                        {
                            "action": "REJECT",
                            "nextState": "REJECTED",
                            "roles": [
                                "EST_ADMIN_SANC"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "REJECTED",
                    "applicationStatus": "REJECTED",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": false,
                    "isStateUpdatable": true,
                    "actions": [
                        {
                            "action": "EDIT",
                            "nextState": "CREATED",
                            "roles": [
                                "EST_CREATOR"
                            ]
                        }
                    ]
                },
                {
                    "sla": null,
                    "state": "APPROVED",
                    "applicationStatus": "APPROVED",
                    "docUploadRequired": false,
                    "isStartState": false,
                    "isTerminateState": true,
                    "isStateUpdatable": false,
                    "actions": null
                }
            ]
        }
    ]
}

Sample Curl to fetch ProcessInstance

curl 'https://works-dev.digit.org/estimate-service/estimate/v1/_search?tenantId=pb.amritsar&department=DEPT_1&typeofwork=Road&fromProposalDate=1667241000000&toProposalDate=1667845799000&limit=10&sortBy=department&sortOrder=DESC&_=1667829358481' \
  -H 'authority: works-dev.digit.org' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: en-US,en;q=0.9' \
  -H 'content-type: application/json;charset=UTF-8' \
  -H 'origin: https://works-dev.digit.org' \
  -H 'referer: https://works-dev.digit.org/works-ui/employee/works/search-Estimate' \
  -H 'sec-ch-ua: "Google Chrome";v="107", "Chromium";v="107", "Not=A?Brand";v="24"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Linux"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36' \
  --data-raw '{
    "RequestInfo":{
      "apiId":"Rainmaker",
      "authToken":"153c3161-55ce-4485-96fa-f67ea9757eea",
      "msgId":"1667829358480|en_IN",
      "plainAccessRequest":{}
    }
  }'

Taking Actions on Estimate

An Action bar on the View Estimate Screen shows the list of actions

Forward Estimate
Reject Estimate
Modify Estimate
Approve Estimate

When any action is clicked respective popup is rendered according to the selected action. We have created three popups for approve, forward and reject. They are shown below

Sample curl for Update Estimate

curl 'http://localhost:3000/estimate-service/estimate/v1/_update' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Accept-Language: en-US,en;q=0.9' \
  -H 'Connection: keep-alive' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'Origin: http://localhost:3000' \
  -H 'Referer: http://localhost:3000/works-ui/employee/works/view-estimate?tenantId=pb.amritsar&estimateNumber=EP/2022-23/11/000143&department=DEPT_1' \
  -H 'Sec-Fetch-Dest: empty' \
  -H 'Sec-Fetch-Mode: cors' \
  -H 'Sec-Fetch-Site: same-origin' \
  -H 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36' \
  -H 'sec-ch-ua: "Google Chrome";v="107", "Chromium";v="107", "Not=A?Brand";v="24"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Linux"' \
  --data-raw '{
      "estimate":{
          "id":"e9d1e26c-7231-4fad-97f0-297dab173c23",
          "tenantId":"pb.amritsar",
          "estimateNumber":"EP/2022-23/11/000143",
          "adminSanctionNumber":null,
          "proposalDate":1667824800917,
          "status":"ACTIVE",
          "estimateStatus":"CREATED",
          "subject":"Construct new schools",
          "requirementNumber":"88888999",
          "description":"Construct new schools",
          "department":"DEPT_1",
          "location":"pb.amritsar:ADMIN:pb.amritsar:Z1:B2:SUN40",
          "workCategory":"Engineering",
          "beneficiaryType":"SC",
          "natureOfWork":"Operation & Maintenance",
          "typeOfWork":"Road",
          "subTypeOfWork":"RD01",
          "entrustmentMode":"e-Procurement",
          "fund":"02",
          "function":"0003",
          "budgetHead":"03",
          "scheme":"AMRUT",
          "subScheme":"AMRUT-01",
          "totalAmount":null,
          "estimateDetails":[{
              "id":"4cbef8e4-aa3c-4c93-a954-a94f04ea8c96",
              "estimateDetailNumber":"EP/2022-23/11/000143/000124",
              "name":"Amrut Yojana",
              "amount":98760,
              "additionalDetails":null
          }],
          "auditDetails":{
              "createdBy":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
              "lastModifiedBy":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
              "createdTime":1667824800916,
              "lastModifiedTime":1667824800916
          },
          "additionalDetails":{
              "owner":"Est Super User",
              "formData":{},
              "createdBy":"Est Super User",
              "filesAttached":[]
          }
      },
      "workflow":{
              "action":"CHECK",
              "comment":"Okay",
              "assignees":["c8d0093a-4d2b-495f-8bdf-fd9d3594e43f"]
      },
      "RequestInfo":{
              "apiId":"Rainmaker",
              "authToken":"153c3161-55ce-4485-96fa-f67ea9757eea",
              "userInfo":{
                  "id":110,
                  "uuid":"c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
                  "userName":"EST_SUPER",
                  "name":"Est Super User",
                  "mobileNumber":"9876543210",
                  "emailId":"",
                  "locale":null,
                  "type":"EMPLOYEE",
                  "roles":[
                      {
                      "name":"Employee",
                      "code":"EMPLOYEE",
                      "tenantId":"pb.amritsar"
                      },{
                      "name":"EST_CHECKER",
                      "code":"EST_CHECKER",
                      "tenantId":"pb.amritsar"
                      },{
                      "name":"EST TECH SANC",
                      "code":"EST_TECH_SANC",
                      "tenantId":"pb.amritsar"
                      },{
                      "name":"EST FIN SANC",
                      "code":"EST_FIN_SANC",
                      "tenantId":"pb.amritsar"
                      }
                  ],
                  "active":true,
                  "tenantId":"pb.amritsar",
                  "permanentCity":null
              },
          "msgId":"1667833964561|en_IN","plainAccessRequest":{}
      }
      }'

Users must have the respective roles for taking actions on the Estimate, Otherwise the Action Bar will not be visible. And users can only take actions on the applications assigned to them.