W&S Promotion Document v2.1

Description:

The Water & Sewerage module deals with the process of applying and managing water & sewerage connections. This module has both Citizen and employee facing components. As part of Phase 2, the citizen has the ability to Initiate connections, Submit application, resubmit application and many more actions (Based on workflow), make payment for application, print receipts, download bills etc. The Employee and Other roles like ws doc verifier, field inspector can take action based on workflow action.

Notes:

This service integrates with Property Registry
In case Property ID is not provided as part of the create water/sewerage connection application will not be generated.
Counter Employees , Document Verifier, Field Inspector, Approver and Clerk performing actions on user application must have suitable state-level roles

Actors: Citizen, Counter Employee, Document Verifier, Field Inspector, Approver, Clerk

Technical Documents:

Please find the updated technical document for the Water & Sewerage module at the below link:

Water Service Technical Document - Water Service - Technical Document

Sewerage Service Technical Document - Sewerage Service - Technical Document

Promotion Steps:

Backend

Promote the following MDMS folders (all files within the folder)
https://github.com/egovernments/egov-mdms-data/tree/master/data/pb/ws-services-masters
https://github.com/egovernments/egov-mdms-data/tree/master/data/pb/ws-services-calculation
https://github.com/egovernments/egov-mdms-data/tree/master/data/pb/sw-services-calculation
Latest BusinessService JSON for fee calculation egov-mdms-data/data/pb/BillingService/BusinessService.json at master · egovernments/egov-mdms-data
Latest TaxHeadMaster JSON for the new tax heads for Water and Sewerage

egov-mdms-data/data/pb/BillingService/TaxHeadMaster.json at master · egovernments/egov-mdms-data

Latest TaxPeriod JSON the Tax Periods for Water and Sewerage egov-mdms-data/data/pb/BillingService/TaxPeriod.json at master · egovernments/egov-mdms-data
Latest FinancialYear JSON which includes FY details for Water and Sewerage modules - FinancialYear.json

Add the following objects to the masterconfig.json (Add in ws-services-masters,ws-services-calculation and sw-services-calculation)

ws-services-masters:

"ws-services-masters": {
    "connectionCategory": {
      "masterName": "connectionCategory",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.code"
      ]
    },
    "connectionType": {
      "masterName": "connectionType",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.code"
      ]
    },
    "waterSource": {
      "masterName": "waterSource",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.code"
      ]
    },
    "billingPeriod": {
      "masterName": "billingPeriod",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.billingCycle"
      ]
    }
  }

ws-services-calculation:

"ws-services-calculation": {
    "WaterCess": {
      "masterName": "WaterCess",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "Interest": {
      "masterName": "Interest",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.fromFY"
      ]
    },
    "Rebate": {
      "masterName": "Rebate",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.fromFY"
      ]
    },
    "Penalty": {
      "masterName": "Penalty",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.fromFY"
      ]
    },
    "WCBillingSlab": {
      "masterName": "WCBillingSlab",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "WS_CHARGE": {
      "masterName": "WS_CHARGE",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "WS_TIME_PENALTY": {
      "masterName": "WS_TIME_PENALTY",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "WS_WATER_CESS": {
      "masterName": "WS_WATER_CESS",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "MeterStatus": {
      "masterName": "MeterStatus",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "WS_Round_Off": {
      "masterName": "WS_Round_Off",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "PlotSizeSlab": {
      "masterName": "PlotSizeSlab",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "PropertyUsageType": {
      "masterName": "PropertyUsageType",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "FeeSlab": {
      "masterName": "FeeSlab",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "RoadType": {
      "masterName": "RoadType",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "CalculationAttribute": {
      "masterName": "CalculationAttribute",
      "isStateLevel": true,
      "uniqueKeys": []
    }
  }

sw-services-calculation:

"sw-services-calculation": {
    "Interest": {
      "masterName": "Interest",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.fromFY"
      ]
    },
    "Rebate": {
      "masterName": "Rebate",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.fromFY"
      ]
    },
    "Penalty": {
      "masterName": "Penalty",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.fromFY"
      ]
    },
    "SCBillingSlab": {
      "masterName": "SCBillingSlab",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "billingPeriod": {
      "masterName": "billingPeriod",
      "isStateLevel": true,
      "uniqueKeys": [
        "$.billingCycle"
      ]
    },
    "SW_CHARGE": {
      "masterName": "SW_CHARGE",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "SW_TIME_PENALTY": {
      "masterName": "SW_TIME_PENALTY",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "SW_Round_Off": {
      "masterName": "SW_Round_Off",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "PlotSizeSlab": {
      "masterName": "PlotSizeSlab",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "PropertyUsageType": {
      "masterName": "PropertyUsageType",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "FeeSlab": {
      "masterName": "FeeSlab",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "RoadType": {
      "masterName": "RoadType",
      "isStateLevel": true,
      "uniqueKeys": []
    },
    "CalculationAttribute": {
      "masterName": "CalculationAttribute",
      "isStateLevel": true,
      "uniqueKeys": []
    }
  }

Role Configuration:

Web Page & API Access:

https://github.com/egovernments/egov-mdms-data/tree/master/data/pb/ACCESSCONTROL-ACTIONS-TEST

In the above file, define the access for the following APIs, Card Type URLs and Menu Type URLs.

Map the API action against each role as required @ roleactions.json

Define the list of Water & Sewerage service employee roles @ roles.json

Migrate the following IDGEN formats to
https://github.com/egovernments/egov-mdms-data/blob/master/data/pb/common-masters/IdFormat.json

Endpoints

Please whitelist endpoint from zuul wherever required

Auth Based Access: Employee

/ws-services/wc/_create
/ws-services/wc/_update
/sw-services/wc/_update
/sw-services/wc/_create
/ws-calculator/waterCalculator/_estimate
/sw-calculator/sewerageCalculator/_estimate
/ws-services/wc/_search
/sw-services/wc/_search

Auth Based: Citizen, Employee

/ws-services/wc/_search :- mixed (both whitelisted and auth based)
/sw-services/wc/_search :- mixed (both whitelisted and auth based)

Open EndPoints

In, helm/environments/qa.yaml - Please whitelist endpoint from zuul for ‘egov-open-endpoints-whitelist’ param and add value /pdf-service/v1/_create

Users:

Employee with ULB level access
Citizen associated with an ULB

Workflow config

We need to create the WF config in BusinessService. To do that call the “_create” API in BusinessService and add the below JSON content in the request body.

Businees Service Request URI - https://egov-micro-dev.egovernments.org/egov-workflow-v2/egov-wf/businessservice/_create

Water Service WF Config:

Sewerage Service WF Config:

PDF Templates

Migrate the following files for PDF Generations

https://github.com/egovernments/configs/tree/master/pdf-service/format-config

https://github.com/egovernments/configs/tree/master/pdf-service/data-config

Note - The data-config file might access MDMS directly to fetch the details. Open each file and check is there any MDMS query (search for egov-mdms-service). If there are any MDMS query configured - update the state level tenantId value properly.

Persister Config

Indexer Config

Egov-Searcher Config

Add “waterbills” and “seweragebills” section to the bill-genie as mentioned in the below file.

https://github.com/egovernments/configs/blob/master/egov-searcher/bill-genie.yml

Add “ws-services” and “sw-services” section to locality search as mentioned in the below file.

https://github.com/egovernments/configs/blob/master/egov-searcher/localitySearcher.yml

Infra Ops Config

MIgrate the master branch dev.yaml files configuration for to qa.yaml for the following service

PDF Service
Indexer Service

Update the WS-Services and SW-Services config values from the latest helm files.

BillingService

Update the “billGeneiURL” param in ws-service-calculation and sw-services-calculation object with the latest value - “egov-searcher/bill-genie/billswithaddranduser/_get”

File path in Dev - egov-mdms-data/data/pb/BillingService/BusinessService.json at master · egovernments/egov-mdms-data

Localisation File

https://docs.google.com/spreadsheets/d/1JTnaV1BDtFWPIX_h4y2WtmGKB-lEthTyCfnDjKzHMSE/edit#gid=0

Service Builds

Module	Image Details
Billing Service	egovio/billing-service:6-0.0.1-DEMAND_ADVANCE_APPORTION-e8609dd
Property Service	property-services:167-PT_SERVICES_FEATURE-9386a21d
PDF Service	egovio/pdf-service:25-pdf-add-1b2fb5b
Employee	egovio/employee:380-0.0.1-RELEASE-2020-v3-01-07024bfc6
Citizen	egovio/citizen:345-0.0.1-RELEASE-2020-v3-01-07024bfc6
WS-Service	egovio/ws-services:80-1.0.0-master-67c2139c
WS-Calculator	egovio/ws-calculator:45-1.0.0-master-d7529cf4
SW-Service	egovio/sw-services:34-1.0.0-master-a2ee0ed4
SW-Calculator	egovio/sw-calculator:26-1.0.0-master-67e5a1bc
Egov-Searcher	egovio/egov-searcher:2-searcher-feature-095e997
Collection Service	egovio/collection-services:10-2.0.0-miscellaneous-collection-fix-ac1d2bb
Apportion Service	egovio/egov-apportion-service:10-0.0.1-APPORTION_ADVANCE-944d6f0

Swagger API

https://app.swaggerhub.com/apis/egov-foundation/Water-Sewerage-1.0/1.0.0#/free

Postman Collection

Postman collection for Create Water and Sewerage API’s

https://www.getpostman.com/collections/b6cd12cda7caaa2d4580 (Water service)
https://www.getpostman.com/collections/c5ce66e0c8c263b40444 (WS Calculation Service)
https://www.getpostman.com/collections/27458a8c6249d786317c (Sewerage service and calculation service)

Features Covered as part of Release (includes Phase 1 & Phase 2 Features)

Module	Feature
Citizen	Search Connection No to pay for Water / Sewerage Bill
Citizen	Pay for Water / Sewerage Bill
Citizen	View Bill For Application no
Citizen	Download / Print Receipt immediately after successful payment
Citizen	View and download receipts of past payments
Citizen	View existing connections & their details
Citizen	Apply new Water / Sewerage connection
Citizen	Edit Water / Sewerage connection application and re-submit
Citizen	View applied Water / Sewerage applications & details
Citizen	Download & Print Application Details,Estimation Details (for field inspected applications) and Sanction Details (for approved connections)
Employee	Search Connection No
Employee	View connection details.
Employee	View consumption details and Add meter reading (for metered connection)
Employee	Collect Dues
Employee	Download / Print Receipt immediately after successful payment
Employee	Search Application No
Employee	Add new Water / Sewerage connection
Employee	Edit Water / Sewerage connection application
Employee	View applied Water / Sewerage applications & details
Employee	Download & Print Application Details,Estimation Details (for field inspected applications) and Sanction Details (for approved connections)
	Generate Bill for metered connections
Employee	Bill Genie Integration
Backend	Job Scheduler for scheduled demand generation
Employee	Merge and download bills
Citizen	Notification of application state change.
Citizen	Receive notification of bill generated
Citizen	Search Property criteria included for City, MobileNumber, Old Property ID, Unique Property Id
Citizen	Register Property details while applying for W&S Connection
Employee	Search Property criteria included for City, MobileNumber, Old Property Id, Unique Property Id
Employee	Register Property details while applying for W&S Connection
Citizen	Citizens can search property which belongs to another person and the same can be used to create W&S applications. This is configurable.
	Bill and Receipt PDF configurations are specific to W&S module

Pending Features

Citizen

Notification of payment failure

Out of Scope

None.