Rate Analysis

Rate Analysis frontend tech document

Overview

The Rate analysis Module helps in creating rate analysis for Works type of SOR, and helps in bifurcating the rate and revision of rates.

The module has 5 associated screens :

• Create Rate Analysis

• View Rate Analysis

• Edit Rate Analysis

Configurations

MDMS Configurations

S.No.	Data	MDMS Link
1	SOR Data	SOR MDMS Data
2	Overheads	Overheads

Module Enablement Configuration

Set module code as “RateAnalysis” in Module.js of Rate Analysis Module. Refer to the file citymodule

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

Enable Module in App.js. Update the object ‘enabledModules’. Use the code RateAnalysis. This code should match the code of the cityModule.json, mentioned above. Role-action Mapping

S.No.	API	Action ID	Roles
1	/mdms-v2/v2/_create/WORKS-SOR.Composition	9	MDMS_STATE_ADMIN
2	/mdms-v2/v2/_update/WORKS-SOR.Composition	10	MDMS_STATE_ADMIN
3	/rate-analysis/v1/_calculate	11	ESTIMATE_CREATOR, MDMS_STATE_ADMIN

Sidebar Configuration

S.No.	Screen	Navigation URL	Left Icon Updates	Roles
1	Rate Analysis	/workbench-ui/employee/workbench/mdms-search-v2?moduleName=WORKS-SOR&masterName=Composition	dynamic:=ContractIcon	MDMS_STATE_ADMIN, MDMS_CITY_VIEW_ADMIN

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

   {
      "id": 192,
      "name": "MDMS",
      "url": "url",
      "displayName": "Manage Works SOR Composition",
      "orderNumber": 1,
      "parentModule": "",
      "enabled": true,
      "serviceCode": "MDMS",
      "code": "null",
      "navigationURL": "/workbench-ui/employee/workbench/mdms-search-v2?moduleName=WORKS-SOR&masterName=Composition",
      "path": "9MDMS.WORKS-SOR.Composition",
      "leftIcon": "dynamic:ContractIcon"
    }

Screen Configuration

S.No.	Screen	Configuration
1	Create Rate Analysis	Create Rate Analysis
2	View Rate Analysis	View Rate Analysis

Localization Configuration & Modules

TenantID	Module
od	rainmaker-common
od	rainmaker-rateanalysis
od	rainmaker-common-masters

Workflow Configuration

There is no workflow associated with the Rate Analysis, Only create, view and update screens are present, once the Rate Analysis is created, Users can View and edit the composition.

Customisation

Custom Components used in Rate Analysis:

1. SORDetailsTemplate - This Component is used to search the SOR and add it in the template but mentioning the quantity of each basic sors.

2. ExtraCharges - This Component is used to add the additional charges which is not present in the form of basic sors.

3. TableWithOutHead - This Component is used to show the total value of data with total LC and per unit cost.

4. RateCardWithRightButton - This Component is used to show the composition data with its rate value

5. RateAmountGroup - This Component is used to show the Existing rate and new rate for the particular works sor.

6. ExtraChargesViewTable - This Component is used to show the additional charges added during the creation of composition.

Create/ Edit Rate Analysis Screen:

1. Use the common Utility “useCustomAPIHook” to gather the data needed for validation and composition creation.

2. Use the common Utility “getDefaultValues” to gather the init state of the create form.

3. Pass the createState dependencies to the formComposer.

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

5. Figures and additional details is captured in the screen.

View Rate Analysis Screen:

1. Use the common Utility “useViewRateAnalysisDetails” to gather the data to show from the calculate API of rate analysis.

2. Call the "viewRateAnalysisdataconfig" to render the view config for the rate analysis according to the dynamic data recieved

3. Pass the config in the "ViewComposer" to show the segregation of the data according to different heads of Rates.