Water and Sewerage- Promotion Document
- Dharmalingam K (Unlicensed)
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 1, the citizen has the ability to search connections, make payments, print receipts, download bills etc. The employee has the option to search connections, receive payments and enter meter reading
Notes:
This service integrates with Property Registry which is also in development.
In case Property ID is not provided as part of the create water/sewerage connection a new property is created using the data provided.
Employees performing actions on user application must have suitable state-level roles
Actors: Citizen, Employee
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
Add new Business service to https://github.com/egovernments/egov-mdms-data/blob/master/data/pb/BillingService/BusinessService.json
{
"businessService": "ws-services-calculation",
"code": "WS",
"collectionModesNotAllowed": [
"DD"
],
"partPaymentAllowed": true,
"isAdvanceAllowed": true,
"demandUpdateTime": 86400000,
"isVoucherCreationEnabled": false
},
{
"businessService": "sw-services-calculation",
"code": "SW",
"collectionModesNotAllowed": [
"DD"
],
"partPaymentAllowed": true,
"isAdvanceAllowed": true,
"demandUpdateTime": 86400000,
"isVoucherCreationEnabled": false
}
Update taxhead master to define the new tax heads for Water and Sewerage
{
"category": "CHARGES",
"service": "WS",
"name": "Water Charges",
"code": "WS_CHARGE",
"isDebit": true,
"isActualDemand": false,
"order": "0",
"isRequired": false
},
{
"category": "TAX",
"service": "WS",
"name": "Rebate",
"code": "WS_TIME_REBATE",
"isDebit": true,
"isActualDemand": false,
"order": "0",
"isRequired": false
},
{
"category": "TAX",
"service": "WS",
"name": "Interest",
"code": "WS_TIME_INTEREST",
"isDebit": false,
"isActualDemand": true,
"order": "1",
"isRequired": false
},
{
"category": "TAX",
"service": "WS",
"name": "Water Cess",
"code": "WS_WATER_CESS",
"isDebit": false,
"isActualDemand": true,
"order": "2",
"isRequired": false
},
{
"category": "PENALTY",
"service": "WS",
"name": "Penalty",
"code": "WS_TIME_PENALTY",
"isDebit": false,
"isActualDemand": true,
"order": "3",
"isRequired": false
},
{
"category": "TAX",
"service": "WS",
"name": "Round Off",
"code": "WS_Round_Off",
"isDebit": false,
"isActualDemand": true,
"order": "4",
"isRequired": false
},
{
"category": "CHARGES",
"service": "SW",
"name": "Sewerage Charges",
"code": "SW_CHARGE",
"isDebit": true,
"isActualDemand": false,
"order": "0",
"isRequired": false
},
{
"category": "TAX",
"service": "SW",
"name": "Rebate",
"code": "SW_TIME_REBATE",
"isDebit": true,
"isActualDemand": false,
"order": "1",
"isRequired": false
},
{
"category": "TAX",
"service": "SW",
"name": "Interest",
"code": "SW_TIME_INTEREST",
"isDebit": false,
"isActualDemand": true,
"order": "2",
"isRequired": false
},
{
"category": "PENALTY",
"service": "SW",
"name": "Penalty",
"code": "SW_TIME_PENALTY",
"isDebit": false,
"isActualDemand": true,
"order": "3",
"isRequired": false
},
{
"category": "TAX",
"service": "SW",
"name": "Round Off",
"code": "SW_Round_Off",
"isDebit": false,
"isActualDemand": true,
"order": "4",
"isRequired": false
}Update taxperiod to include the Tax Periods for Water and Sewerage
{
"fromDate": 1554076800000,
"toDate": 1585612800000,
"periodCycle": "ANNUAL",
"service": "WS",
"code": "WC2018",
"financialYear": "2019-20"
},
{
"fromDate": 1554076800000,
"toDate": 1585612800000,
"periodCycle": "ANNUAL",
"service": "SW",
"code": "SC2018",
"financialYear": "2019-20"
}
Add the following to the masterconfig.json
Migrate the https://github.com/egovernments/egov-mdms-data/blob/master/data/pb/egf-master/FinancialYear.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/meterConnection/_create
/ws-calculator/meterConnection/_calculate
/sw-calculator/meterConnection/_calculate
/sw-calculator/sewerageCalculator/_calculate
Auth Based: Citizen, Employee
/ws-services/wc/_search :- mixed (both whitelisted and auth based)
/sw-services/wc/_search :- mixed (both whitelisted and auth based)
Users:
Employee with ULB level access
Citizen associated with an ULB
Workflow config
Not Applicable
Service Builds
Billing Service - billing-service:61-BILL_V2_FEATURE-39a9d0a
Property Service - property-services:28-PROPERTY_REGISTRY_FEATURE-0c1ef88
Citizen: citizen:376-release-Jan_6-bc2b1a6f
Employee: employee:399-release-Jan_6-bc2b1a6f
Sewerage Calculator - sw-calculator:9-ws_tarento_release_Jan_6-7187801
Sewerage Services - sw-services-db:11-ws_tarento_release_Jan_6-3d105cb
Water Services - ws-services:30-ws_tarento_release_Jan_6-c707d37
Water Calculator - ws-calculator:26-ws_tarento_release_Jan_6-2dd1932
PDF Service - pdf-service:33-pdf-changes-1ceb7c9
Swagger API’s
https://github.com/egovernments/municipal-services/tree/ws_tarento_release_Jan_6/sw-calculator/docs
https://github.com/egovernments/municipal-services/tree/ws_tarento_release_Jan_6/sw-services/docs
https://github.com/egovernments/municipal-services/tree/ws_tarento_release_Jan_6/ws-calculator/docs
https://github.com/egovernments/municipal-services/tree/ws_tarento_release_Jan_6/ws-services/docs
Postman Collection
Postman collection for Create Water and Sewerage API’s
https://drive.google.com/file/d/1mi4_8Wg9djRM9fobGgvKvz8fyHXt3Ixx/view?usp=sharing 1
Persister Config
https://github.com/egovernments/configs/tree/master/egov-persister/sewerage-persist.yml
https://github.com/egovernments/configs/tree/master/egov-persister/water-meter.yml
https://github.com/egovernments/configs/tree/master/egov-persister/water-persist.yml
Localisation File
https://docs.google.com/spreadsheets/d/1JTnaV1BDtFWPIX_h4y2WtmGKB-lEthTyCfnDjKzHMSE/edit#gid=0
Features Covered as part of Release
Module | Feature |
Citizen | Search Connection |
Citizen | View Bill |
Citizen | Pay Dues if any (Full or Partial Payment) |
Citizen | Download / Print Receipt immediately after successful payment |
Employee | Search Connection |
Employee | View Bill |
Employee | Collect Dues |
Employee | Download / Print Receipt immediately after successful payment |
Employee | Enter meter reading of connections individually |
Generate Bill for metered connections | |
Citizen | View and download receipts of past payments |
Citizen | View existing connections |
Citizen | View connection details |
Pending Features
Citizen | Receive notification of bill generated |
Citizen | Notification of payment failure |
Employee | Merge and download bills |
Backend | Job Scheduler for scheduled demand generation |
Out of Scope
The Format for Bill and Receipt are being handled by the common PDF services. There are still hard coded values for Property in the format. We have raised the same with the concerned team
Bill Genie integration is pending. There is no change required from W&S module. The changes will have to be incorporated in the bill genie module