Measurement Book (Mobile Application)

Measurement Book Tech Document

Overview

This module helps in taking the measurement, for an accepted contract

Roles: MB_CREATOR, MB_VERIFIER, MB_APPROVER,MB_VIEWER

This module has 5 associated screens :

Inbox
Create
Edit
Update
Search

Home Screen

This screen renders dynamically based on the user's role mapping. It contains two cards: Measurement Book and Work-order Book. These modules are displayed according to the roles assigned to the logged-in user. If the user has the role of MB Creator, the Work-order card will be visible. Similarly, if the user has the MB_VERIFIER, MB_APPROVER,MB_VIEWER role, the Measurement card will be visible. If the user has both roles, both cards will be displayed.

User Actions in Work Order Inbox

New Measurement Book creation:

Tap the "Create Measurement Book" button on any work order to generate a new measurement book.

Work Order Filter:

Users can filter the work order list by work order number, ward, and CBO name.

Work Order Sorting:

Users have the flexibility to sort the entire list based on the amount or CBO name.

User Actions in Measurement Book Inbox:

Existing Measurement Book view/update:

Users can update/view measurement books by tapping on the Create Measurement Book button of any of the work orders.

Measurement Book Filter:

Users have the flexibility in the application to filter the work-order list based on the Measurement Number, projectId, ward and workflow state.

Measurement Book Sorting:

Users have been given the flexibility to sort the whole list based on the amount, SLA days remaining and workflow state.

Create Measurement Book

To create the new Measurement Book, The user is required to go to the Work-order inbox screen by tapping the work-order card on the home screen. In that screen, multiple work orders assigned to him will be available in the list. He/she can tap on the work order to create a Measurement Book.

Conditions for check before Creating new Measurement Book

There are certain check points are expected to be validated before navigating to create a new Measurement Book screen from the work-order card.

SNo	CheckPoints	MB create?
1	If the existing MB for the selected work-order is in workflow state	NO
2	Time Extension is in progress	NO
3	Revision Estimate is in progress	NO
4	Above points are approved in state	YES

SNo

CheckPoints

MB create?

If the existing MB for the selected work-order is in workflow state

Time Extension is in progress

Revision Estimate is in progress

Above points are approved in state

YES

API specifications for the validation:

SNo. API body Description

SNo.	API	body	Description
1	`mukta-services/measurement/_search`	{ `"contractNumber": "", "tenantId": "",` }	Gives the list of measurements related to the contract Number
2	`estimate/v1/_search`	`{ "tenantId": "", "estimateNumber":"" }`	Gives the estimate details for the estimate Number

mukta-services/measurement/_search

{

"contractNumber": "",
        "tenantId": "",

}

Gives the list of measurements related to the contract Number

estimate/v1/_search

{
          "tenantId": "",
          "estimateNumber":""
        }

Gives the estimate details for the estimate Number

Measurement Book create screen:

This screen contains the below components:

SORs, NON-SORs cards for the current opened screen
The primary detail section contains the previous MB list and the brief description of the MB.
Workflow button

User Action in Measurement Book Screen:

User can fill the measurement of the SORs and NON-SORs associated with Work-order. Image of the worksite can be uploaded by the Measurement book reader as to give proof of work done.

After filling the necessary details , user has been given two options such as Save-as-draft and submit.

if the user does save as draft he has the control to edit it as many time as he wants. once the form is submitted. then He can not edit the application in the same screen.

API Specification for Measurement Book Creation:

SNo API body Description

SNo	API	body	Description
1	`egov-hrms/employees/_search`	{"`roles":""` `"isActive":""` `"tenantId":""}`	Fetches the HRMS employees
2	`measurement-service/v1/_create`	{ "documents": [], 'id': "", 'tenantId': "", 'measurementNumber': "", 'entryDate': "", 'isActive': "", 'wfStatus': "", 'referenceId': "", 'physicalRefNumber': "", 'workflow': { 'action': "", 'comments': "", 'assignes': , 'documents': [], 'additionalDetails': { 'endDate': "", 'sorAmount': "", 'startDate': "", 'totalAmount': "", 'nonSorAmount': "", 'musterRollNumber': [], }, 'measures': [{ 'description': "", 'comments': "", 'targetId': "", 'breadth': "", 'length': "", 'height': "", 'isActive': "", 'referenceId': "", 'numItems': "", 'id': "", 'cumulativeValue': "", 'currentValue': "", 'additionalDetails': { 'type': "", 'mbAmount': "", 'measureLineItems': [], }, }; ], };	Create new measurement

egov-hrms/employees/_search

{"roles":""

"isActive":""

"tenantId":""}

Fetches the HRMS employees

measurement-service/v1/_create

{
      "documents": 
            [],
      'id': "",
      'tenantId': "",
      'measurementNumber': "",
      'entryDate': "",
      'isActive': "",
      'wfStatus': "",
      'referenceId': "",
      'physicalRefNumber': "",
      'workflow': {
        'action': "",
        'comments': "",
        'assignes': ,
        'documents': [],
      'additionalDetails': {
        'endDate': "",
        'sorAmount': "",
        'startDate': "",
        'totalAmount': "",
        'nonSorAmount': "",
        'musterRollNumber': [],
      },
      'measures': [{
          'description': "",
          'comments': "",
          'targetId': "",
          
          'breadth':
              "",
          'length':
              "",
          'height':
              "",
          'isActive': "",
          'referenceId': "",
          'numItems': "",
          'id': "",
          'cumulativeValue': "",
          'currentValue': "",
          'additionalDetails': {
            'type': "",
            'mbAmount': "",
            'measureLineItems': [],
          },
        };
      ],
    };

Create new measurement

Measurement Book View/Edit/Update:

In order to update or edit the measurement book, the user has to navigate from home screen to measurement Book Inbox by tapping on the Measurement Book Card. In the MB Inbox Screen he/she can edit or update any measurement book by tapping the Open Measurement Book button.

User Action in Measurement Book Screen:

In this screen use can take the actions:

Verify And Forward
Approve
Send Back
Reject
Edit

API Specification for Measurement Book Update:

SNo. API Body Description

SNo.	API	Body	Description
1	`mukta-services/measurement/_search`	{ `"contractNumber:"", "measurementNumber": "", "key":"View", });` }	fetching the measurement book details
2	`measurement-service/v1/_update`	{ "documents": [], 'id': "", 'tenantId': "", 'measurementNumber': "", 'entryDate': "", 'isActive': "", 'wfStatus': "", 'referenceId': "", 'physicalRefNumber': "", 'workflow': { 'action': "", 'comments': "", 'assignes': , 'documents': [], 'additionalDetails': { 'endDate': "", 'sorAmount': "", 'startDate': "", 'totalAmount': "", 'nonSorAmount': "", 'musterRollNumber': [], }, 'measures': [{ 'description': "", 'comments': "", 'targetId': "", 'breadth': "", 'length': "", 'height': "", 'isActive': "", 'referenceId': "", 'numItems': "", 'id': "", 'cumulativeValue': "", 'currentValue': "", 'additionalDetails': { 'type': "", 'mbAmount': "", 'measureLineItems': [], }, }; ], };	updating the current measurement book
3	`egov-workflow-v2/egov-wf/process/_search`	`{"history":"",` `"tenantId":"",` `"businessIds":""` `}`	fetches the workflow for the curent measurement book

mukta-services/measurement/_search

{

"contractNumber:"",
        "measurementNumber": "",
        "key":"View",
      });

}

fetching the measurement book details

measurement-service/v1/_update

{
      "documents": 
            [],
      'id': "",
      'tenantId': "",
      'measurementNumber': "",
      'entryDate': "",
      'isActive': "",
      'wfStatus': "",
      'referenceId': "",
      'physicalRefNumber': "",
      'workflow': {
        'action': "",
        'comments': "",
        'assignes': ,
        'documents': [],
      'additionalDetails': {
        'endDate': "",
        'sorAmount': "",
        'startDate': "",
        'totalAmount': "",
        'nonSorAmount': "",
        'musterRollNumber': [],
      },
      'measures': [{
          'description': "",
          'comments': "",
          'targetId': "",
          
          'breadth':
              "",
          'length':
              "",
          'height':
              "",
          'isActive': "",
          'referenceId': "",
          'numItems': "",
          'id': "",
          'cumulativeValue': "",
          'currentValue': "",
          'additionalDetails': {
            'type': "",
            'mbAmount': "",
            'measureLineItems': [],
          },
        };
      ],
    };

updating the current measurement book

egov-workflow-v2/egov-wf/process/_search

{"history":"",

"tenantId":"",

"businessIds":""

}

fetches the workflow for the curent measurement book

DIGIT Components & Custom Components Used:

SNO Component Path Description

SNO	Component	Path	Description
1	Common MB Card	measurement card	Custom card with key value data binding
2	Multi line Items	`multiline items`	custom component contains the digit card component with multi-line calculation functionalities
3	Floating Action Card	floating action card	this component contains the floating action button with showModalBottomSheet functions
4	DropDownDialog	DropDownDialog	A dialog with dropdown options
5	DigitElevatedButton	DigitElevatedButton	An Elevated Submit Button

Common MB Card

measurement card

Custom card with key value data binding

Multi line Items

multiline items

custom component contains the digit card component with multi-line calculation functionalities

Floating Action Card

floating action card

this component contains the floating action button with showModalBottomSheet functions

DropDownDialog

A dialog with dropdown options

DigitElevatedButton