Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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:

...

Sewerage Service Technical Document - Sewerage Service - Technical Document

Promotion Steps:

Backend

...

Code Block
{
        "format": "WS/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "waterservice.connection.id"
     },
     {
        "format": "SW/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "sewerageservice.connection.id"
     },
     {
        "format": "WS/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "ws.receipt.id"
     },
     {
        "format": "SW/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "sw.receipt.id"
     },
     {
        "format": "WS_AP/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "waterservice.application.id"
     },
     {
        "format": "SW_AP/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "sewerageservice.application.id"
     },
     {
        "format": "WS.ONE_TIME_FEE/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "ws.one_time_fee.receipt.id"
     },
     {
        "format": "SW.ONE_TIME_FEE/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]",
        "idname": "sw.one_time_fee.receipt.id"
     }

Endpoints

Please whitelist endpoint from zuul wherever required

...

  • /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.

...

Code Block
{
  “RequestInfo” : {
      “authToken” : “authTokenValue”
   },
  "BusinessServices": [
    {
      "tenantId": "pb",
      "businessService": "NewSW1",
      "business": "sw-services",
      "businessServiceSla": 259200000,
      "states": [
        {
          "sla": null,
          "state": null,
          "applicationStatus": null,
          "docUploadRequired": false,
          "isStartState": true,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "INITIATE",
              "nextState": "INITIATED",
              "roles": [
                "CITIZEN",
                "SW_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "INITIATED",
          "applicationStatus": "INITIATED",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "SUBMIT_APPLICATION",
              "nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
              "roles": [
                "CITIZEN",
                "SW_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "PENDING_FOR_CITIZEN_ACTION",
          "applicationStatus": "PENDING_FOR_CITIZEN_ACTION",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "RESUBMIT_APPLICATION",
              "nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
              "roles": [
                "CITIZEN",
                "SW_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "PENDING_FOR_DOCUMENT_VERIFICATION",
          "applicationStatus": "PENDING_FOR_DOCUMENT_VERIFICATION",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "VERIFY_AND_FORWARD",
              "nextState": "PENDING_FOR_FIELD_INSPECTION",
              "roles": [
                "SW_DOC_VERIFIER"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "SW_DOC_VERIFIER"
              ]
            },
            {
              "action": "SEND_BACK_TO_CITIZEN",
              "nextState": "PENDING_FOR_CITIZEN_ACTION",
              "roles": [
                "SW_DOC_VERIFIER"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "REJECTED",
          "applicationStatus": "REJECTED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        },
        {
          "sla": 86400000,
          "state": "PENDING_FOR_FIELD_INSPECTION",
          "applicationStatus": "PENDING_FOR_FIELD_INSPECTION",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": true,
          "isTerminateState": false,
          "actions": [
            {
              "action": "VERIFY_AND_FORWARD",
              "nextState": "PENDING_APPROVAL_FOR_CONNECTION",
              "roles": [
                "SW_FIELD_INSPECTOR"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "SW_FIELD_INSPECTOR"
              ]
            },
            {
              "action": "SEND_BACK_FOR_DOCUMENT_VERIFICATION",
              "nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
              "roles": [
                "SW_FIELD_INSPECTOR"
              ]
            }
          ]
        },
        {
          "sla": 43200000,
          "state": "PENDING_APPROVAL_FOR_CONNECTION",
          "applicationStatus": "PENDING_APPROVAL_FOR_CONNECTION",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": true,
          "isTerminateState": false,
          "actions": [
            {
              "action": "APPROVE_FOR_CONNECTION",
              "nextState": "PENDING_FOR_PAYMENT",
              "roles": [
                "SW_APPROVER"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "SW_APPROVER"
              ]
            },
            {
              "action": "SEND_BACK_FOR_FIELD_INSPECTION",
              "nextState": "PENDING_FOR_FIELD_INSPECTION",
              "roles": [
                "SW_APPROVER"
              ]
            }
          ]
        },
        {
          "sla": 43200000,
          "state": "PENDING_FOR_PAYMENT",
          "applicationStatus": "PENDING_FOR_PAYMENT",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "PAY",
              "nextState": "PENDING_FOR_CONNECTION_ACTIVATION",
              "roles": [
                "CITIZEN",
                "SW_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "PENDING_FOR_CONNECTION_ACTIVATION",
          "applicationStatus": "PENDING_FOR_CONNECTION_ACTIVATION",
          "isStateUpdatable": true,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "actions": [
            {
              "action": "ACTIVATE_CONNECTION",
              "nextState": "CONNECTION_ACTIVATED",
              "roles": [
                "SW_CLERK"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "CONNECTION_ACTIVATED",
          "applicationStatus": "CONNECTION_ACTIVATED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        }
      ]
    }
  ]
}

PDF Templates

Migrate the following files for PDF Generations

...

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/localitySearcher.yml

Infra Ops Config

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

...

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 - https://github.com/egovernments/egov-mdms-data/blob/master/data/pb/BillingService/BusinessService.json

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

Postman Collection

Postman collection for Create Water and Sewerage API’s

  1. https://www.getpostman.com/collections/b6cd12cda7caaa2d4580 (Water service)

  2. https://www.getpostman.com/collections/c5ce66e0c8c263b40444 (WS Calculation Service)

  3. 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

...