1 of 58

Configuration

Master Data Templates

Configure master data templates for MuktaSoft

Objective

This section is designed with the objective of helping implementation parties and end-users collect the required master data through minimal interaction and iterations and ensure the quality, consistency and shape of data needed to configure the system.

Audience

This page is intended to help stakeholders as given below on data gathering activities.

State Team
eGov Onsite Team/ Implementation Team
ULB Team (Nodal and DEO)
Implementation Partners

Output Artefacts

The artefacts of this document are the data template of a configurable entity, a page with content defining the entity template and helping on how to fill the template with required data.

Data Entry

Download the data template attached to this page.
Find the meaning of the different headers in the Data Definition section on this page
Make sure all the headers, data type, field size and definition/ description are clear. In case of any doubt, please reach out to the person who has shared this document with you to discuss the same and clear out the doubts.
Identify the different types of user roles on the basis of ULB functions.
Start filling the data starting from serial no. and complete a record at once. Repeat this exercise until the entire data is filled into a template.
Verify the data once again by going through the checklist and taking care of each and every point mentioned in the checklist.

Checklist

The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

This checklist covers the activities which are specific to the entity.

Project Type

Introduction

Project types are the category of works which are included and executed under the scheme MUKTA.

Data Table

Sr. No.

Code*

Project Type*

Project Type (Odiya)

Effective From

Effective To

Is Active

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Attachments

Target Demography

Introduction

Target demography are the areas which are on prime focus of Government for the employment and improvement.

Data Table

Sr. No.

Code

Project Type

Project Type (Odiya)

Effective From

Effective To

Is Active

Slum

ବସ୍ତି

Area inhabited by SC

ଅନୁସୂଚିତ ଜାତି (ଏସ.ସି)ସମ୍ପ୍ରଦାୟ ବାସ କରୁଥିବା ଅଞ୍ଚଳ

Area inhabited by ST

ଅନୁସୂଚିତ ଜନଜାତି (ଏସ.ଟି)ସମ୍ପ୍ରଦାୟ ବାସ କରୁଥିବା ଅଞ୍ଚଳ

Area inhabited by Minorities

ସଂଖ୍ୟାଲଘୁ ସମ୍ପ୍ରଦାୟ ବାସ କରୁଥିବା ଅଞ୍ଚଳ

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Code

Alphanumeric

Yes

A unique code that identifies the project type.

Project Type

Text

256

Yes

Provides the name of the project type

Project Type (Odiya)

Text

256

Project type name in local language

Effective From

Date

Date from which the project is effective

Effective To

Date

Date till which the project is effective

Is Active

Boolean

Whether the project is active or not

Attachments

Unit Of Measurement (Units)

Introduction

Unit of measurements is the units used to capture the measurement and create the estimate for work in MUKTA.

Data Table

Sr. No.

Code

Description

Description (Odiya)

Effective From

Effective To

Is Active

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Attachments

Overheads

Introduction

Overheads are the items other than SOR and Non-SOR which are included in the estimate to complete the estimation and arrive the final value of work.

Data Table

Sr. No.

Code

Description

Description (Odiya)

Is work order value?

Calculation Method

Percentage/ Value

Effective From

Effective To

Is Active

Supervision Charge

ତଦାରଖ ଦେୟ

Yes

Percentage

7.5

GST

Goods and Service Tax

ଦ୍ରବ୍ୟ ଏବଂ ସେବା କର

Yes

Percentage

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Code

Alphanumeric

Yes

A unique code that identifies the project type.

Description

Text

256

Yes

Provides the name of the project type

Description (Odiya)

Text

256

Project type name in local language

Is work order value?

Boolean

Calculation Method

Identifier

Percentage/Value

Numeric

Effective From

Date

Date from which the project is effective

Effective To

Date

Date till which the project is effective

Is Active

Boolean

Whether the project is active or not

Attachments

Community-Based Organisation Roles

Role definition master data templates

Introduction

In MUKA community-based organizations have different roles to play based on the work value. The role defined is Implementation Agengency and Implementation Partner.

Data Table

Sr. No.

Code

Description

Description (Odiya)

Effective From

Effective To

Is Active

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Attachments

Scheme

Introduction

MUKTA is known as a scheme and it is configured in the system along with its HOAs.

Data Table

Sr. No.

Code

Description

Description (Odiya)

Effective From

Effective To

Is Active

MUKTA

ମୁକ୍ତା

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Code

Alphanumeric

Yes

A unique code that identifies the project type.

Scheme Name

Text

256

Yes

Provides the name of the project type

HOA

Text

256

Project type name in local language

Effective From

Date

Date from which the project is effective

Effective To

Date

Date till which the project is effective

Is Active

Boolean

Whether the project is active or not

Attachments

Standard Deductions

Introduction

These are deductions which are made from the purchase bills and then remitted to respective departments.

Data Table

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Attachments

Organisation Type

Introduction

The Community Based Organization and Vendors are created as 2 different type of organization.

Data Table

Sr. No.

Code

Description

Description (Odiya)

Effective From

Effective To

Is Active

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Attachments

Organisation Sub Type

Introduction

The Community Based Organization are further categories and refered as sub type.

Data Table

Sr. No.

Parent Code (Org Type)

Code

Description

Description (Odiya)

Effective From

Effective To

Is Active

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Attachments

Skill Category & Skills

Introduction

Skills are defined for the wage seekers and have different wages defined for each skill category. These wages are revised by the government over a period of time.

Data Table

Sr. No.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Attachments

HRMS Designation

Introduction

These are designations of the employees working within the ULB across different sections.

Data Table

Sr. No.

Parent Code

Code

Description

Description (Odiya)

Effective From

Effective To

Is Active

WRK

Executive Engineer

କାର୍ଯ୍ୟନିର୍ବାହୀ ଯନ୍ତ୍ରୀ

WRK

DEE

Deputy Executive Engineer

ଡେପୁଟି କାର୍ଯ୍ୟନିର୍ବାହୀ ଯନ୍ତ୍ରୀ

WRK

AEE

Assistant Executive Engineer

ସହକାରୀ କାର୍ଯ୍ୟନିର୍ବାହୀ ଯନ୍ତ୍ରୀ

WRK

Municipal Engineer

ମ୍ୟୁନିସିପାଲିଟି ଇଞ୍ଜିନିୟର୍ (ଯନ୍ତ୍ରୀ)

WRK

City Enginner

ସିଟି ଇଞ୍ଜିନିୟର୍ (ଯନ୍ତ୍ରୀ)

WRK

Assistant Enginner

ସହକାରୀ ଯନ୍ତ୍ରୀ

WRK

Junior Enginner

କନିଷ୍ଠ ଯନ୍ତ୍ରୀ

WRK

Revenue Inspector

ରାଜସ୍ୱ ନିରୀକ୍ଷକ

WRK

Ameen

ଅମିନ୍

WRK

Dealing Assistant

ସଂପୃକ୍ତ ସହାୟକ

WRK

Program Coordinator (MUKTA)

ପ୍ରୋଗ୍ରାମ(କାର୍ଯ୍ୟ) ସଂଯୋଜକ (ମୁକ୍ତା)

WRK

Implementation Expert (MUKTA)

କାର୍ଯ୍ୟାନ୍ୱୟନ /କାର୍ଯ୍ୟକାରୀ ବିଶେଷଜ୍ଞ (ମୁକ୍ତା)

WRK

ACCE

Account Expert (MUKTA)

ଆକାଉଣ୍ଟ ବିଶେଷଜ୍ଞ (ମୁକ୍ତା)

ACC

Accounts Officer

ଆକାଉଣ୍ଟସ୍ ଅଫିସର(ହିସାବ ଅଧିକାରୀ)

ACC

JAO

Junior Accounts Officer

କନିଷ୍ଠ ଆକାଉଣ୍ଟସ୍ ଅଫିସର(ହିସାବ ଅଧିକାରୀ)

ADM

Commissioner

କମିଶନର

ADM

ADMC

Additional Commissioner

ଅତିରିକ୍ତ କମିଶନର

ADM

DMC

Deputy Commissioner

ଡେପୁଟି କମିଶନର

ADM

AMC

Assistant Commissioner

ସହକାରୀ କମିଶନର

ADM

Executive Officer

କାର୍ଯ୍ୟନିର୍ବାହୀ ଅଧିକାରୀ

ADM

AEO

Assistant Executive Officer

ସହକାରୀ କାର୍ଯ୍ୟନିର୍ବାହୀ ଅଧିକାରୀ

Tax

Ward Officer

ୱାର୍ଡ ଅଫିସର

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Code

Alphanumeric

Yes

A unique code that identifies the project type.

Project Type

Text

256

Yes

Provides the name of the project type

Project Type (Odiya)

Text

256

Project type name in local language

Effective From

Date from which the project is effective

Effective To

Date till which the project is effective

Is Active

Whether the project is active or not

Attachments

User Role

Introduction

The roles defined in the system carry specific functionality and need to map with users when created in the system to enable the user to use the respective functionality.

Data Table

Sr. No.

Code

Role Description

Action

Service

PROJECT_CREATOR

Poject Creator

Create Search View Modify

Project

PROJECT_VIEWER

Project Viewer

Search View

Project

ESTIMATE_CREATOR

Estimate Creator

Inbox Create Search View Edit

Estimate

ESTIMATE_VERIFIER

Estimate Verifier

Inbox Search View Verify and Forward Send Back

Estimate

TECHNICAL_SANCTIONER

Technical Sanctioner

Inbox Search View Technically Sanction Send Back Send Back To Originator Reject

Estimate

ESTIMATE_APPROVER

Estimate Approver

Inbox Search View Approve Send Back Send Back To Originator Reject

Estimate

WORK_ORDER_CREATOR

Work Order Creator

Inbox Create Search View Edit

Contract

WORK_ORDER_VIEWER

Work Order Verifier

Inbox Search View Verify and Forward Send Back

Contract

WORK_ORDER_APPROVER

WOrk Order Approver

Inbox Search View Approve Send Back Send Back To Originator Reject

Contract

MUSTER_ROLL_VERIFIER

Muster Roll Verifier

Inbox Search View Edit Verify and Forward Send Back

Muster Roll

MUSTER_ROLL_APPROVER

Muster Roll Approver

Inbox Search View Approve Send Back

Muster Roll

MUKTA_ADMIN

MUKTA Admin

Create Organization Search Organization View Organization Modify Organization Search Wage Seeker View Wage Seeker Modify Wage Seeker

Masters

HRMS_ADMIN

HRMS Admin

Create Employee Search Employee View Employee Modify Employee

Employee Users

STADMIN

Dashboard Viewer

Mukta Dashboard

ORG_ADMIN

CBO Admin

all actions of CBO portal

CBO Portal

BILL_CREATOR

Bill Creator

Inbox Search View Create

Billing

BILL_VIEWER

Bill Viewer

Inbox Search View

Billing

EMPLOYEE_COMMON

Common Role For all employee

This role will have all common access that employee should have like edit profile, get Workflow status etc

Common

ESTIMATE_VIEWER

Estimate Viewer

View

Estimate

The data given in the table is sample data for reference.

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Is Mandatory?

Definition/ Description

Code

Alphanumeric

Yes

A unique code that identifies the project type.

Project Type

Text

256

Yes

Provides the name of the project type

Project Type (Odiya)

Text

256

Project type name in local language

Effective From

Date from which the project is effective

Effective To

Date till which the project is effective

Is Active

Whether the project is active or not

Attachments

 {
            "module": "Project",
            "code": "Project",
            "active": true,
            "order": 8,
            "tenants": [
                {
                    "code": "pg.cityb"
                },
                {
                    "code": "pg.cityc"
                },
                {
                    "code": "pg.citya"
                }
            ]
},

 {
     "id": 15,
     "name": "PROJECT",
     "url": "url",
     "displayName": "Create Project",
     "orderNumber": 1,
     "parentModule": "",
     "enabled": true,
     "serviceCode": "PROJECT",
     "code": "null",
     "navigationURL": "/works-ui/employee/project/create-project",
     "path": "1PROJECT.Create",
     "leftIcon": "dynamic:ProjectIcon"
  }


works-ui:
  custom-js-injection: |
    sub_filter.conf: "
      sub_filter  '<head>' '<head>
      <script src={{INSERT_YOUR_AWS_BUCKET_NAME}}/globalConfigsWorks.js type=text/javascript></script>';"

var globalConfigs = (function () {
  var stateTenantId = 'pg' // statetenantId
   var gmaps_api_key = '<<INSERT_GMAP_GENERATED_TOKEN>>';
   var contextPath = 'works-ui'; 
   var configModuleName = 'commonMuktaUiConfig'; 
   var centralInstanceEnabled = false;
   var footerBWLogoURL = '{{INSERT_YOUR_AWS_BUCKET_NAME}}/digit-footer-bw.png';
   var footerLogoURL = '{{INSERT_YOUR_AWS_BUCKET_NAME}}/digit-footer.png';
   var digitHomeURL = 'https://www.digit.org/';
   var xstateWebchatServices = 'wss://dev.digit.org/xstate-webchat/';
   var assetS3Bucket = '{{INSERT_YOUR_AWS_BUCKET_NAME}}';
   var invalidEmployeeRoles = ["CBO_ADMIN","STADMIN","ORG_ADMIN","ORG_STAFF","SYSTEM"] 

 
   var getConfig = function (key) {
     if (key === 'STATE_LEVEL_TENANT_ID') {
       return stateTenantId;
     }
     else if (key === 'GMAPS_API_KEY') {
       return gmaps_api_key;
     }
     else if (key === 'ENABLE_SINGLEINSTANCE') {
       return centralInstanceEnabled;
     } else if (key === 'DIGIT_FOOTER_BW') {
       return footerBWLogoURL;
     } else if (key === 'DIGIT_FOOTER') {
       return footerLogoURL;
     } else if (key === 'DIGIT_HOME_URL') {
       return digitHomeURL;
     } else if (key === 'xstate-webchat-services') {
       return xstateWebchatServices;
     } else if (key === 'S3BUCKET') {
       return assetS3Bucket;
     } else if (key === 'CONTEXT_PATH'){
	return contextPath;
     } else if (key === 'UICONFIG_MODULENAME'){
	return configModuleName;
     } else if (key === 'INVALIDROLES'){
	return invalidEmployeeRoles;
     }
   };
 
 
   return {
     getConfig
   };
 }());

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"
                }
            ]
        }
}

WageSeeker (CBO Application)

Wageseeker TechDocument

Overview

This module helps create wage seekers.

ROLE: ORG_ADMIN

This module contains 4 linked forms

Individual Details
Address Details
Financial Details
Summary Details

Individual Details

S.No.

Fields

Mandatory

Validations

Aadhaar No.

Yes

Input: [0-9]

Max Length: 12

Min Length: 12

Name

Yes

Input: [A-Za-z ]

Max Length: 128

Min Length: 2

Guardian Name

Yes

Input: [A-Za-z ]

Max Length: 128

Min Length: 2

Relationship

Yes

None

Date of Birth

Yes

Age shouldn’t be less than 18 years

Gender

Yes

None

Social Category

None

Mobile Number

Yes

Input: [0-9]

Max Length: 10

Min Length: 10

Skills

Yes

Can not select multiple skills of same sub skill type

10.

Photograph

File size should be < 5 MB

Address Details

S.No.

Fields

Mandatory

Validations

Pincode

Input: [0-9]

Max Length: 6

Min Length: 6

City

Yes

None

Ward

Yes

None

Locality

Yes

None

Street Name

Max Length: 64

Min Length: 0

Door No

Max Length: 64

Min Length: 0

Financial Details

S.No.

Fields

Mandatory

Validations

Account Holder’s Name

Yes

Input: [A-Za-z ]

Max Length: 128

Min Length: 2

Account Number

Yes

Input: [0-9]

Max Length: 18

Min Length: 9

Re-enter Account Number

Yes

Input: [0-9]

Max Length: 18

Min Length: 9

Account Type

Yes

None

IFSC Code

Yes

Valid IFSC Code

Verified through

https://ifsc.razorpay.com

This form combines the details of the previous 3 forms, and users can tap on the respective edit icon to edit the particular details.

On submit, the wage seeker is created successfully.

API Details

S. no.

API

Body/Query Params

Description

'individual/v1/_create'

"Individual": {

"tenantId":,

"name": {"givenName": ,

"dateOfBirth":,

"gender":,

"mobileNumber":,

"address": [

{

"tenantId":,

"pincode":,

"street":,

"doorNo":,

"type": "PERMANENT",

"locality": {"code":

"fatherName":,

"husbandName":,

"relationship":,

"identifiers": [

{

"identifierType": "AADHAAR",

"identifierId":

}

"skills": [],

"photo":,

"additionalFields": {

"fields": [

{

"key": "SOCIAL_CATEGORY",

"value":

}

]

}

Create Individual/Wage seekers

'/bankaccount-service/bankaccount/v1/_create'

"bankAccounts": [

{

"tenantId":,

"serviceCode": "IND",

"referenceId": individualId,

"bankAccountDetails": [

{

"tenantId":,

"accountHolderName":

"accountNumber":,

"accountType":,

"isPrimary",

"bankBranchIdentifier": {

"type": "IFSC",

"code":,

"additionalDetails": {"ifsccode"}

"isActive": true,

"documents": [],

}

]

To create the bank details for the individual that was created

Organization

Organization Tech Document

This module helps in creating an organization which are business functions that work with ULB to execute projects. These can be typical contractors, SHGs or material vendors. All of them are registered under the same Organization Master.

This module has 4 associated screens :

Create
Search
View
Modify

MDMS Configurations

S.No.

Data

MDMS Link

OrgType

OrgFunctionCategory

OrgFunctionClass

OrgTaxIdentifier

BankAccType

OrgTransferCode

TenantBoundary

Module enablement configuration

Set module code as “Masters” in Module.js for Masters (Organization) Module. Refer CityModule.json

 {
            "module": "Masters",
            "code": "Masters",
            "active": true,
            "order": 6,
            "tenants": [
                {
                    "code": "pg.cityb"
                },
                {
                    "code": "pg.cityc"
                },
                {
                    "code": "pg.citya"
                }
            ]
     }

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

Role-action mapping

S.No

API

Action ID

Roles

/org-services/organisation/v1/_create

100

MUKTA_ADMIN

/org-services/organisation/v1/_search

MUKTA_ADMIN, ORG_ADMIN, WORK_ORDER_CREATOR

/org-services/organisation/v1/_update

101

MUKTA_ADMIN

Sidebar configuration

S.No

Screen

Navigation URL

LeftIcon Updates

Roles

Create Organisation

/works-ui/employee/masters/create-organization

dynamic:OrganisationIcon

MUKTA_ADMIN

Search Organisation

/works-ui/employee/masters/search-organization

dynamic:OrganisationIcon

MUKTA_ADMIN

Screen configuration

S.No

Screen

Configuration

Create/Modify

Localization Configuration and Modules

TenantID

Module

rainmaker-masters

rainmaker-common-masters

rainmaker-common

pg.citya

rainmaker-pg.citya

Workflow Configuration

Customization

Custom Components used

TransferCodeTable -

This component is a common component used to show Tax identifiers and Transfer Codes input options in the ‘Financial Details’ section in Create screen
Dropdown options for tax identifiers and transfer codes are populated by MDMS data
Used can select type via dropdown and value needs to be entered for the corresponding type
Users can add and delete rows for tax identifiers since there can be multiple identifiers. First row won't be deleted.
Refer Component: TransferCodeComponent

2. Create Organization Screen

Please use the common Utility “PreProcessMDMSConfig”.
Pass the associated dependencies for the config.
The utility will return a config that will run through FormComposer.
Refer to docs for Pre-Process config in Component comments.
Tax Identifiers and Transfer Codes are MDMS data.

3. Search Organization 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.
All the Inbox and Search Screens throughout the app are rendered using this component Inbox/Search Composer
Validations added
All Form validations are being added in the Screen Configurations. Add the populators for respective validations and mention the JSON path for the Pre-Process to work.
IFSC code has 2 validations as below

Pattern validation (given in config)
Third-party API is being used to get band and branch name based on entered valid IFSC code, This API throws 404 if the code is not valid, in that case the valid error message is displayed below the input field
Tax identifiers are not mandatory while creating Organisation. But as per API implementation, it's required in payload hence we send a dummy identifier value if the user has not entered anything in Tax identifier input. In the View Organisation screen if the PAN value is above the dummy value then ‘NA’ is displayed on the screen.

Default value: Type => PAN, Value => XXXXX0123X

Attendance (CBO Application)

Overview

This module helps in logging the attendance of each individual in a register and creating the muster roll for a particular week.

ROLE: ORG_ADMIN

This module has 2 associated screens : View Register Inbox Track Attendance Table Screen

MDMS Configurations

S.No.

Data

MDMS Link

AttendanceHours

WageSeekerSkills

CBOMusterSubmission

User actions

On this page, the following actions need to be performed: The CBO Admin needs to select the date range from the Date Picker.

On the Selection of any date from the Picker, the whole week gets selected by default. On Selecting the particular week, and Clicking on Apply, the user can view the pre-saved attendance log for the respective week User can change the attendance log for each individual, And then click on the Save as Draft button to save the attendance log,

The user can submit the muster roll, On Click of submit the muster roll, the user will be asked to fill in the skills for each individual, After filling skills of each individual, the user can submit the muster roll for that particular week

Validations If a Date range is not selected or cleared, the Save as Draft Button will throw an error to select the date range Submission of muster roll depends upon the CBOMusterSubmission MDMS Config

isEndOfWeek && selectedDateRange!.endDate > DateTime.now().millisecondsSinceEpoch


code": "END_OF_WEEK",            "value": "end of week",            "active": false

If END_OF_WEEK is false, the user can create the muster roll on any day of the week, else user can submit the muster roll on or after the last day of the week (i.e. Sunday) If there is an existing muster roll for the selected range, and the muster is in workflow,

Track Attendance page will be a view page, else it will allow to log attendance and submit muster roll Based on the Attendance Hours list, users will be allowed to mark the attendance as Full Day, Half Day, or absent. If the list is of length 2, users will be allowed to mark only Full and Absent, Else, users can mark half-day as well.

API Details

S.No

API

Body / Query Params

Description

attendance/v1/_search

{

"tenantId":””,

"ids":””

}

Gives the list of registers linked to the org

muster-roll/v1/_estimate

{

"musterRoll": {

"tenantId":,

"registerId":,

"startDate":,

"endDate":

}

To get the attendance log for the selected Date range

attendance/log/v1/_create

{"attendance": []}

To log the attendance of the individuals for the week

attendance/log/v1/_update

To update the attendance log of the individuals for Sent Back To CBO Muster Rolls

muster-roll/v1/_search

To check if any existing muster rolls present for the selected week

egov-workflow-v2/egov-wf/businessservice/_search

{

"tenantId":,

"businessServices": “musterRollId”,

}

To check the workflow status of the Muster Roll

Sidebar configuration

DIGIT Components and Custom Components Used

S.No

Component

Path

Description

DigitTable

Custom Table with fixed first column and other columns scrollable

DropDownDialog

A dialog with dropdown options

DateRangePicker

A custom Date Range picker to select a range of the month / year

DigitElevatedButton

An Elevated Submit Button

WorkDetailsCard

Details Card based on DIGIT Figma design

Localization Configuration and Modules

TenantID

Module

rainmaker-common

rainmaker-attendance

rainmaker-common-masters

rainmaker-workflow

pg.citya

rainmaker-pg.citya

Reference Files/Links

Blocs :

Models :

Repositories:

Screens

WageSeeker

Wageseeker Tech Document

Overview

This module helps in creating an individual(Wage Seeker) , it is needed in Mukta to assign work, track attendance and process DBTs.

This module has 3 associated screens :

Search
View
Modify

MDMS Configurations

S.No.

Data

MDMS Link

Relationship

GenderType

SocialCategory

WageSeekerSkills

TenantBoundary

Module enablement configuration

Set module code as “Masters” in Module.js for Masters (Organization) Module. Refer CityModule.json

 {
            "module": "Masters",
            "code": "Masters",
            "active": true,
            "order": 6,
            "tenants": [
                {
                    "code": "pg.cityb"
                },
                {
                    "code": "pg.cityc"
                },
                {
                    "code": "pg.citya"
                }
            ]
     }

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

Role-action mapping

S.No

API

Action ID

Roles

/individual/v1/_search

MUKTA_ADMIN, ORG_ADMIN

/individual/v1/_update

MUKTA_ADMIN, ORG_ADMIN

/individual/v1/_delete

MUKTA_ADMIN, ORG_ADMIN

Sidebar configuration

S.No

Screen

Navigation URL

LeftIcon Updates

Roles

Search Individual

/works-ui/employee/masters/search-wageseeker

dynamic:WageseekerIcon

MUKTA_ADMIN

Sample object for a sidebar action define in MDMS (containing navigationUrl)

{
      "id": 78,
      "name": "WAGESEEKER",
      "url": "url",
      "displayName": "Masters Search Wageseeker",
      "orderNumber": 10,
      "parentModule": "",
      "enabled": true,
      "serviceCode": "WageSeeker",
      "code": "null",
      "navigationURL": "/works-ui/employee/masters/search-wageseeker",
      "path": "8WageSeeker.Search",
      "leftIcon": "dynamic:WageseekerIcon"
    }

Screen configuration

S.No

Screen

Configuration

Create/Modify

Localization Configuration and Modules

TenantID

Module

rainmaker-masters

rainmaker-common-masters

rainmaker-common

pg.citya

rainmaker-pg.citya

Workflow Configuration

Customization

Modify Individual Screen

Please use the common Utility “PreProcessMDMSConfig”.
Pass the associated dependencies for the config.
The utility will return a config which will run through FormComposer.
Refer docs for Pre-Process config in Component comments.

Search Individual Screen

Please use the common utility “preProcessMDMSConfigInboxSearch”.
Pass the associated dependencies for the config.
The utility will return a config which will run through RenderFormFields.
Refer docs for Pre-Process config in Component comments.
All the Inbox and Search Screens throughout the app are rendered using this component Inbox/Search Composer

Validations added

All Form validations are being added in the Screen Configurations. Add the populators for respective validations and mention the JSON path for the Pre-Process to work.

Delete API Usage

To update individual skills update Individual and delete individual APIs are being used
If skills already exist then those can be updated with update API, if any skills are to be removed then delete API is used, in this case whole skill object need to be send with ‘isDeleted’ flag equals to true.

Workorder

Workorder/Contract UI Tech Documentation

Overview

This module helps in creating a work order for the Project based on the estimates designed. This enables in deciding the Tendering, Quotation and Nomination. Based on the nomination, CBO is being mapped to the respective Work Order.

This module has 5 associated screens :

Create
Search
Modify
View
Inbox

MDMS Configurations

S.No.

Data

MDMS Link

Role Of CBO

Document Config

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/works/DocumentConfig.json

Module enablement configuration

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

 {
            "module": "Contracts",
            "code": "Contracts",
            "active": true,
            "order": 5,
            "tenants": [
                {
                    "code": "pg.cityb"
                },
                {
                    "code": "pg.cityc"
                },
                {
                    "code": "pg.citya"
                }
            ]
     }

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

Role-action mapping

S.No

API

Action ID

Roles

/contract-service/contract/v1/_create

WORK_ORDER_CREATOR

/contract-service/contract/v1/_search

WORK_ORDER_CREATOR, WORK_ORDER_APPROVER, WORK_ORDER_VERIFIER

/contract-service/contract/v1/_update

WORK_ORDER_CREATOR, WORK_ORDER_APPROVER, WORK_ORDER_VERIFIER

/estimate-service/estimate/v1/_search

ESTIMATE_VERIFIER

/pms/project/v1/_search

PROJECT_VIEWER

/egov-hrms/employees/_search

EMPLOYEE_COMMON

/org-services/organisation/v1/_search

ORG_ADMIN, WORK_ORDER_CREATOR, MUKTA_ADMIN

/wms/contract/_search

WORK_ORDER_CREATOR, WORK_ORDER_VERIFIER

Sidebar configuration

S.No

Screen

Navigation URL

LeftIcon Updates

Roles

Contract Inbox

/works-ui/employee/contracts/inbox

dynamic:ContractIcon

WORK_ORDER_CREATOR, WORK_ORDER_VERIFIER, WORK_ORDER_APPROVER

Create Contract

/works-ui/employee/estimate/search-estimate

dynamic:ContractIcon

WORK_ORDER_CREATOR

{
      "id": 58,
      "name": "CONTRACTS",
      "url": "url",
      "displayName": "Contracts Inbox",
      "orderNumber": 2,
      "parentModule": "",
      "enabled": true,
      "serviceCode": "CONTRACTS",
      "code": "null",
      "navigationURL": "/works-ui/employee/contracts/inbox",
      "path": "3CONTRACTS.Inbox",
      "leftIcon": "dynamic:ContractIcon"
   }

Screen configuration

S.No

Screen

Configuration

Create

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/commonMuktaUiConfig/CreateWorkOrderConfig.json

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/commonMuktaUiConfig/SearchContractConfig.json

Inbox

https://github.com/egovernments/works-mdms-data/blob/DEV/data/pg/commonMuktaUiConfig/InboxConfigContracts.json

Localization Configuration and Modules

TenantID

Module

rainmaker-contracts

rainmaker-common-masters

rainmaker-common

rainmaker-workflow

pg.citya

rainmaker-pg.citya

Workflow Configuration

UI Component Name

Business Service

WorkflowActions

contract-approval-mukta

Customization

1. API-based Data -

Name of CBO - This field is being captured on the Create screen and Modify screen. Data for this field comes from the backend.
CBO ID - This field is being set based on the value selected in the Name Of CBO.
Name of Officer In Charge - This field is being populated based on the HRMS Search. Here the role is hardcoded to ‘OFFICER_IN_CHARGE’.
Designation of Officer In Charge - This field is being set based on the value selected in the Name of Officer in charge.
Work Order Amount - This field shows the calculated amount of Total Estimated Cost minus the Overheads which has ‘isWorkOrderValue’ as true. Please refer this OverHeads config for Amount calculation.
Role of CBO will be shown based on the calculated Work Order Amount. If the calculated Work Order Amount is less than ‘amount’ in RoleOfCBO Config, show Implementation Agency else show Implementation Partner. This logic will vary based on the updates in the RoleOfCBO config.

2. Custom Components used in Projects :

Document Config -
Based on the document config, respective documents will be rendered on the Create Screen. Please mention the validations, file type limits and file size limits in this config.
Work Order Terms and Conditions -
This Component will help input description in the table. Users can add and delete the rows. First row won't be deleted, clicking on the delete button will empty the first row. Refer Component - WOTermsAndConditions.

3. Create Screen :

Please use the common Utility “PreProcessMDMSConfig”.
Pass the associated dependencies for the config.
The utility will return a config which will run through FormComposer.
Refer docs for Pre-Process config in Component comments.

4. Inbox / Search Screen :

Please use the common utility “preProcessMDMSConfigInboxSearch”.
Pass the associated dependencies for the config.
The utility will return a config which will run through RenderFormFields.
Refer docs for Pre-Process config in Component comments.

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

Estimate

Estimate module frontend tech documentation

Overview

The Estimate module helps in creating estimates based on projects created. This enables in deciding the Tendering, and Quotation.

The module has 5 associated screens :

Create Estimate
Search Estimate
Edit Estimate
View Estimate
Estimate Inbox

MDMS Configurations

S.No.

Data

MDMS Link

UOM (Unit of Measurement)

Overheads

Document Config

Module Enablement Configuration

Set module code as “Estimate” in Module.js of Estimate Module. Refer to the file CityModule.json

{
            "module": "Estimate",
            "code": "Estimate",
            "active": true,
            "order": 3,
            "tenants": [
                {
                    "code": "pg.cityb"
                },
                {
                    "code": "pg.cityc"
                },
                {
                    "code": "pg.citya"
                }
            ]
        }

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

Role-action Mapping

S.No.

API

Action ID

Roles

/estimate-service/estimate/v1/_create

ESTIMATE_CREATOR

/estimate-service/estimate/v1/_search

ESTIMATE_CREATOR, ESTIMATE_VERIFIER, TECHNICAL_SANCTIONER

ESTIMATE_APPROVER

ESTIMATE_VIEWER

EMPLOYEE_COMMON

/estimate-service/estimate/v1/_update

ESTIMATE_VERIFIER, TECHNICAL_SANCTIONER, ESTIMATE_APPROVER

/wms/estimate/_search

EMPLOYEE_COMMON

/pms/project/v1/_search

PROJECT_VIEWER

Sidebar Configuration

S.No.

Screen

Navigation URL

Left Icon Updates

Roles

Search Estimate

/works-ui/employee/estimate/search-estimate

dynamic:EstimateIcon

ESTIMATE_VIEWER

Estimate Inbox

/works-ui/employee/estimate/inbox

dynamic:EstimateIcon

ESTIMATE_VERIFIER

TECHNICAL_SANCTIONER

ESTIMATE_APPROVER

ESTIMATE_CREATOR

Sample object for a sidebar action define in MDMS( containing navigationUrl )

{
      "id": 17,
      "name": "ESTIMATE",
      "url": "url",
      "displayName": "Estimate Inbox",
      "orderNumber": 2,
      "parentModule": "",
      "enabled": true,
      "serviceCode": "ESTIMATE",
      "code": "null",
      "navigationURL": "/works-ui/employee/estimate/inbox",
      "path": "2ESTIMATE.EstimateInbox",
      "leftIcon": "dynamic:EstimateIcon"
    }

Screen Configuration

S.No.

Screen

Configuration

Create Estimate

Search Estimate

Estimate Inbox

WMS Estimate Search

Localization Configuration & Modules

TenantID

Module

rainmaker-common

rainmaker-estimate

rainmaker-common-masters

rainmaker-workflow

pg.citya

rainmaker-pg.citya

Workflow Configuration

Business Service name - “mukta-estimate”. Refer to the MDMS file for workflow businessServices names - Workflow
For Workflow related actions, the View screens use two components:
- Workflow Actions -> For calling the update API with appropriate workflow action (through the action bar rendered at the bottom of the view screen). This component has all the logic to show actions according to the logged-in user, showing relevant popups and calling the update API to execute an action.
Popups are rendered based on configMap defined in this config file Popup.
- Workflow Timeline -> To show the workflow history on View screens.

Customisation

Custom Components used in Estimate:

Document Config -
- Based on the document config, respective documents will be rendered on the Create Screen. Please mention the validations, file type limits and file size limits in this config
NonSOR Table - Non-SOR Table
- Used in Create Estimate Screen to capture Non-Sor line items.
Overheads Table - Overheads Table
- Used in Create Estimate Screen to capture Overhead items.
Total Estimate Amount - Total Estimate Amount
- Used in Create Estimate Screen to calculate and render Total Estimate Amount.
UploadFileComposer - Upload File Composer
- Used in Create Estimate Screen to render document upload section using Document Config
Labour and Material Analysis- Labour and Material Analysis
- Used in Create Estimate screen to capture labour and material costs. The total labour and material costs cannot be greater than the total Estimate Amount.

Create Estimate Screen:

Use the common Utility “PreProcessMDMSConfig”.
Pass the associated dependencies for the config.
The utility will return a config which will run through FormComposer.
Refer to docs for Pre-Process config in Component comments.
UOM and Overheads captured in the create screen are MDMS data.

Inbox / Search Screen:

Use the common utility “preProcessMDMSConfigInboxSearch”.
Pass the associated dependencies for the config.
The utility will return a config which will run through RenderFormFields.
Refer to docs for Pre-Process config in Component comments.

All the Inbox and Search screens throughout the app are rendered using this component Inbox/Search Composer.

Bill

Overview

This module is used to handle all billing-related actions such as create, update and view Bills.

This module has 5 associated screens :

Create (Purchase Bill)
Search
View (Wage, Purchase, Supervision)
Modify (Purchase Bill)
Download Bills

MDMS Configurations

S.No.

Data

MDMS Link

BillType

TenantBoundary

Module enablement configuration

Set module code as “Expenditure” in Module.js for Billing Module. Refer CityModule.json

{
            "module": "Expenditure",
            "code": "Expenditure",
            "active": true,
            "order": 7,
            "tenants": [
                {
                    "code": "pg.cityb"
                },
                {
                    "code": "pg.cityc"
                },
                {
                    "code": "pg.citya"
                }
            ]
        }

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

Role-action mapping

S.No

API

Action ID

Roles

/expense-calculator/purchase/v1/_createbill

112

BILL_CREATOR

/expense-calculator/v1/_search

113

BILL_CREATOR BILL_VERIFIER BILL_VIEWER BILL_ACCOUNTANT

/expense/bill/v1/_search

106

BILL_CREATOR BILL_VERIFIER BILL_APPROVER BILL_ACCOUNTANT

/wms/expense/_search

110

BILL_CREATOR BILL_VERIFIER BILL_APPROVER BILL_ACCOUNTANT

/expense/payment/v1/_create

116

BILL_ACCOUNTANT

/egov-pdf/bill/_search

114

BILL_CREATOR

/expense/payment/v1/_search

122

BILL_ACCOUNTANT

/expense/payment/v1/_update

125

BILL_ACCOUNTANT

Sidebar configuration

S.No

Screen

Navigation URL

LeftIcon Updates

Roles

Search Bills

/works-ui/employee/expenditure/search-bill

dynamic:ExpenditureIcon

BILL_VIEWER

Sample object for a sidebar action define in MDMS (containing navigationUrl)

{
      "id": 56,
      "name": "BILLS",
      "url": "url",
      "displayName": "Bill Search",
      "orderNumber": 2,
      "parentModule": "",
      "enabled": true,
      "serviceCode": "BILLS",
      "code": "null",
      "navigationURL": "/works-ui/employee/expenditure/search-bill",
      "path": "BILLS.BillSearch",
      "leftIcon": "dynamic:ExpenditureIcon"
    }

Screen configuration

S.No

Screen

Configuration

Create/Modify Purchase bill

Localization Configuration and Modules

TenantID

Module

rainmaker-expenditure

rainmaker-common

rainmaker-common-masters

rainmaker-workflow

pg.citya

rainmaker-pg.citya

Workflow Configuration

Customization

Create Purchase Bill Screen

Please use the common Utility “PreProcessMDMSConfig”.
Pass the associated dependencies for the config.
The utility will return a config which will run through FormComposer.
Refer docs for Pre-Process config in Component comments.

Search Bill Screen

Please use the common utility “preProcessMDMSConfigInboxSearch”.
Pass the associated dependencies for the config.
The utility will return a config which will run through RenderFormFields.
Refer docs for Pre-Process config in Component comments.
All the Inbox and Search Screens throughout the app are rendered using this component Inbox/Search Composer
Checkbox selection is added to results table displayed in search screen based on search config passed via MDMS

Download Bill Screen

DownloadBillConfig is used to render table to show bills where download link is provided to download respective bills

MusterRoll (CBO Application)

Muster Roll Tech Document

Overview

This module helps in viewing and updating the muster rolls.

ROLE: ORG_ADMIN

This module has 2 associated screens :

View Muster Rolls Inbox
Muster Roll Table Screen

MDMS Configurations

S.No.

Data

MDMS Link

AttendanceHours

WageSeekerSkills

Sent Back to CBO

Based on the business workflow state set for Muster Roll ( Sent BAck for Correction) in respective environments, Add the corresponding code in Sent Back to CBO Code MDMS

User actions

On this page, the following actions need to be performed: If the muster roll is in workflow, User can only view the muster roll, If the muster roll is sent back to CBO,then user can edit the attendance and resubmit the muster roll,

Validations

If Muster Roll is in Workflow, The screen will only be a view page and Save as Draft and Re-Submit button will not be shown in the screen
Based on the Attendance Hours list, users will be allowed to mark the attendance as Full Day, Half Day, or absent. If the list is of length 2, users will be allowed to mark only Full and Absent, Else, users can mark halfday as well.

API Details

muster-roll/v1/_estimate

{

"musterRoll": {

"tenantId":,

"registerId":,

"startDate":,

"endDate":

}

To get the attendance log for the selected Date range

attendance/log/v1/_create

{"attendance": []}

To log the attendance of the individuals for the week

attendance/log/v1/_update

To update the attendance log of the individuals for Sent Back To CBO Muster Rolls

muster-roll/v1/_search

To check if any existing muster rolls present for the selected week

egov-workflow-v2/egov-wf/businessservice/_search

{

"tenantId":,

"businessServices": “musterRollId”,

}

To check the workflow status of the Muster Roll

DIGIT Components and Custom Components Used

S.No

Component

Path

Description

DigitTable

Custom Table with fixed first column and other columns scrollable

DropDownDialog

A dialog with dropdown options

DateRangePicker

A custom Date Range picker to select a range of the month / year

DigitElevatedButton

An Elevated Submit Button

WorkDetailsCard

Details Card based on DIGIT Figma design

DigitTimeLine

WorkFlow TimeLine component viewing Workflow state, And Assignees Details

Localization Configuration and Modules

TenantID

Module

rainmaker-common

rainmaker-muster

rainmaker-common-masters

rainmaker-workflow

pg.citya

rainmaker-pg.citya

Reference Files

Blocs :

Models :

Repositories:

Screens

Muster Roll

Muster Roll UI Tech Documentation

Overview

This module helps in processing muster rolls through the workflow. Muster rolls created from SHG app end up in the web interface for workflow approval.

This module has 5 associated screens :

Inbox
Edit
View
Search

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 with the code of the cityModule.json, mentioned above.

Role-action mapping

S.No

API

Action ID

Roles

/muster-roll/v1/_search

MUSTER_ROLL_VERIFIER,MUSTER_ROLL_APPROVER

/muster-roll/v1/_update

MUSTER_ROLL_VERIFIER,MUSTER_ROLL_APPROVER

/egov-pdf/download/musterRoll/muster-roll

104

MUSTER_ROLL_APPROVER,MUSTER_ROLL_VERIFIER

/egov-hrms/employees/_search

EMPLOYEE_COMMON

/expense-calculator/v1/_estimate

108

MUSTER_ROLL_APPROVER,MUSTER_ROLL_VERIFIER

/inbox/v2/_search

EMPLOYEE_COMMON

Sidebar configuration

S.No

Screen

Navigation URL

LeftIcon Updates

Roles

Muster Roll Search

/works-ui/employee/attendencemgmt/search-attendance

dynamic:AttendanceIcon

MUSTER_ROLL_APPROVER,MUSTER_ROLL_VERIFIER

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

S.No

Screen

Configuration

Inbox

Localization Configuration and Modules

TenantID

Module

statea

rainmaker-attendencemgmt

Workflow Configuration

UI Component Name

Business Service

WorkflowActions

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.

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

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":"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

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

{
    "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"
}

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:

/inbox/v2/_search

Sample curl for Inbox API:

curl --location --request POST 'https://works-dev.digit.org/inbox/v2/_search' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RequestInfo": {
        "ts": 0,
        "action": "string",
        "key": "string",
        "msgId": "string",
        "authToken": "ea4069c7-c2a8-4def-a216-ce67352f980d",
        "userInfo": {
            "id": 107,
            "uuid": "c8d0093a-4d2b-495f-8bdf-fd9d3594e43f",
            "userName": "super",
            "name": "Super User",
            "mobileNumber": "1234567890",
            "emailId": null,
            "type": "EMPLOYEE",
            "roles": [
                {
                    "name": "SUPER USER",
                    "code": "SUPERUSER",
                    "tenantId": "pb"
                }
            ],
            "tenantId": "pb.amritsar"
        }
    },
    "inbox": {
        "tenantId": "pb.amritsar",
        "processSearchCriteria": {
            "tenantId": "pb.amritsar",
            "businessService": [
                "muster-roll-approval"
            ],
            "moduleName": "muster-roll-service"
        },
        "moduleSearchCriteria": {
            "tenantId":"pb.amritsar",
            "attendanceRegisterName":"Construct Roads",
            "musterRollStatus":"SUBMITTED",
            "startDate":1670178600000,
            "endDate":1670697000000
        },
        "limit": 10,
        "offset": 0
    }
}'

MDMS Used

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

const { isLoading, data } = Digit.Hooks.useCustomMDMS(
        tenant,
        "commonUiConfig",
        [
            {
                "name": "musterInboxConfig"
            }
        ]
    )

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.

{
    "code": "ATM_ACTUAL_WORKING_DAYS",
    "message": "वास्तविक कार्य दिवस",
    "module": "rainmaker-attendencemgmt",
    "locale": "hi_IN"
}
{
    "code": "ATM_ACTUAL_WORKING_DAYS",
    "message": "Actual Working Days",
    "module": "rainmaker-attendencemgmt",
    "locale": "en_IN"
}

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

API

Role Code

Action Id

Actions

/inbox/v2/_search

JUNIOR_ENGINEER

View inbox for Muster Rolls

/inbox/v2/_search

MUNICIPAL_ENGINEER

View inbox for Muster Rolls

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:

/muster-roll/v1/_update

Sample curl for Update muster API:

curl --location --request POST 'https://works-dev.digit.org/muster-roll/v1/_update' \
--header 'Content-Type: application/json' \
--data-raw '{
  "RequestInfo": {
    "apiId": "asset-services",
    "ver": null,
    "ts": null,
    "action": null,
    "did": null,
    "key": null,
    "msgId": "search with from and to values",
    "authToken": "6ea7d654-234c-4da6-a43f-8b83a3100593",
    "userInfo": {
      "id": 172,
      "uuid": "5ce80dd3-b1c0-42fd-b8f6-a2be456db31c",
      "userName": "8070102021",
      "name": "test3",
      "mobileNumber": "8070102021",
      "emailId": "xyz@egovernments.org",
      "locale": null,
      "type": "EMPLOYEE",
      "roles": [
                {
                    "code": "JUNIOR_ENGINEER",
                    "name": "JUNIOR ENGINEER",
                    "tenantId": "pb.amritsar"
                }
        ]
    }
  },
  "musterRoll": {
    "tenantId": "pb.amritsar",
     "id":"856eb55f-48c7-4439-a046-0d53ed3a99f1"
  },
  "workflow": {
      "action": "VERIFY",
        "comments": "Verify muster roll",
        "assignees": []
        
  }
}'

MDMS Used

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

const getWageSeekerSkills = async () => {
  const skills = {}
  const response = await Digit.MDMSService.getMultipleTypesWithFilter(Digit.ULBService.getStateId(), "common-masters", [{"name": "WageSeekerSkills"}])
  response?.['common-masters']?.WageSeekerSkills.forEach(item => (skills[item.code] = item))
  return skills
}

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.

{
    "code": "ATM_ACTUAL_WORKING_DAYS",
    "message": "वास्तविक कार्य दिवस",
    "module": "rainmaker-attendencemgmt",
    "locale": "hi_IN"
}
{
    "code": "ATM_ACTUAL_WORKING_DAYS",
    "message": "Actual Working Days",
    "module": "rainmaker-attendencemgmt",
    "locale": "en_IN"
}

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

API

Role Code

Action Id

Actions

/muster-roll/v1/_update

JUNIOR_ENGINEER

Reject
Send for Approval
Modify/Verify Muster Roll

/muster-roll/v1/_update

MUNICIPAL_ENGINEER

Approve
Reject

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:

/muster-roll/v1/_search

Sample curl for Search muster API:

curl --location --request POST 'https://works-dev.digit.org/muster-roll/v1/_search?tenantId=pb.amritsar&musterRollNumber=MR/2022-23/01/24/000356' \
--header 'Content-Type: application/json' \
--data-raw '{
  "RequestInfo": {
    "apiId": "asset-services",
    "ver": null,
    "ts": null,
    "action": null,
    "did": null,
    "key": null,
    "msgId": "search with from and to values",
    "authToken": "6ea7d654-234c-4da6-a43f-8b83a3100593",
    "userInfo": {
        "id": 109,
        "uuid": "be99b2c2-5780-4b1c-8e41-e3f8a972ebda",
        "userName": "Nipsyyyy",
        "name": "Nipun ",
        "mobileNumber": "9667076655",
        "emailId": null,
        "locale": null,
        "type": "EMPLOYEE",
        "roles": [
            {
                "name": "Employee",
                "code": "EMPLOYEE",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "EST_CHECKER",
                "code": "EST_CHECKER",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "Organization admin",
                "code": "ORG_ADMIN",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "EST TECH SANC",
                "code": "EST_TECH_SANC",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "HRMS Admin",
                "code": "HRMS_ADMIN",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "Organization staff",
                "code": "ORG_STAFF",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "EST CREATOR",
                "code": "EST_CREATOR",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "LOI APPROVER",
                "code": "LOI_APPROVER",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "EST FIN SANC",
                "code": "EST_FIN_SANC",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "LOI CREATOR",
                "code": "LOI_CREATOR",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "SUPER USER",
                "code": "SUPERUSER",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "EST TECH SANC",
                "code": "EST_ADMIN_SANC",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "MUNICIPAL ENGINEER",
                "code": "MUNICIPAL_ENGINEER",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "LOI CHECKER",
                "code": "LOI_CHECKER",
                "tenantId": "pb.amritsar"
            },
            {
                "name": "JUNIOR ENGINEER",
                "code": "JUNIOR_ENGINEER",
                "tenantId": "pb.amritsar"
            }
        ],
        "active": true,
        "tenantId": "pb.amritsar",
        "permanentCity": "Amritsar"
    }
  }
}'

MDMS Used

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

const getWageSeekerSkills = async () => {
  const skills = {}
  const response = await Digit.MDMSService.getMultipleTypesWithFilter(Digit.ULBService.getStateId(), "common-masters", [{"name": "WageSeekerSkills"}])
  response?.['common-masters']?.WageSeekerSkills.forEach(item => (skills[item.code] = item))
  return skills
}

Localisation

{
    "code": "ATM_ACTUAL_WORKING_DAYS",
    "message": "वास्तविक कार्य दिवस",
    "module": "rainmaker-attendencemgmt",
    "locale": "hi_IN"
}
{
    "code": "ATM_ACTUAL_WORKING_DAYS",
    "message": "Actual Working Days",
    "module": "rainmaker-attendencemgmt",
    "locale": "en_IN"
}

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

API

Role Code

Action Id

Actions

/muster-roll/v1/_search

JUNIOR_ENGINEER

View Individual Muster Roll

/muster-roll/v1/_search

MUNICIPAL_ENGINEER

View Individual Muster Roll

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.