W&S Promotion Document v2.2

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 4, the citizen has the ability to Modify connections and add “Connection Holder” for a connection who is a non-property owner but can access the connection information and receive bills and pay accordingly. The Counter Employee can initiate the Modify Connection application and the same can be approved by the Approver Employee.

Notes:

This promotion document depends on the previous version - DIGIT 2.0 (30.07.2020) : W&S Release Promotion Document Make sure the previous version is properly deployed and running without any issues before performing the changes mentioned in this document.
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.
Only the Property with ‘Active’ status can be allowed to create W&S connection and modify W&S connections.

Actors: Citizen, Counter Employee, Approver

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 (updates from previous version):

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
- ApplicationType.json - provides different type of applications. Latest file as per v2.2. feature is - https://github.com/egovernments/egov-mdms-data/blob/3d99eddb7c272a80ad590ec7ee951d21ce0fc88e/data/pb/ws-services-masters/ApplicationType.json
- ModifyConnectionDocuments.json - provides list of documents which needs to be collected when applying for Modify Water / Sewerage connection. Latest file as per v2.2. feature is - https://github.com/egovernments/egov-mdms-data/blob/b4af2bad4fb9170c4aeca668b247e8f881ea8caa/data/pb/ws-services-masters/ModifyConnectionDocuments.json

Role Configuration:

There are no changes in Role configuration from the previous version

Endpoints

There are no changes in the endpoints.

Users:

Employee with ULB level access
Citizen associated with an ULB

Workflow config

We need to create the WF config in BusinessService for ModifyConnection feature. 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

Modify Water Connection WF Config:

{
  “RequestInfo” : {
      “authToken” : “authTokenValue”
   },
  "BusinessServices": [
    {
      "tenantId": "pb",
      "businessService": "ModifyWSConnection",
      "business": "ws-services",
      "businessServiceSla": 259200000,
      "states": [
        {
          "sla": null,
          "state": null,
          "applicationStatus": null,
          "docUploadRequired": false,
          "isStartState": true,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "INITIATE",
              "nextState": "INITIATED",
              "roles": [
                "WS_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "INITIATED",
          "applicationStatus": "INITIATED",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "SUBMIT_APPLICATION",
              "nextState": "PENDING_FOR_APPROVAL",
              "roles": [
                "WS_CEMP"
              ]
            }
          ]
        },
        {
          "sla": 86400000,
          "state": "PENDING_FOR_APPROVAL",
          "applicationStatus": "PENDING_FOR_APPROVAL",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": true,
          "isTerminateState": false,
          "actions": [
            {
              "action": "APPROVE_CONNECTION",
              "nextState": "APPROVED",
              "roles": [
                "WS_APPROVER"
              ]
            },
            {
              "action": "SEND_BACK",
              "nextState": "INITIATED",
              "roles": [
                "WS_APPROVER"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "WS_APPROVER"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "REJECTED",
          "applicationStatus": "REJECTED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        },
        {
          "sla": null,
          "state": "APPROVED",
          "applicationStatus": "APPROVED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        }
      ]
    }
  ]
}

Sewerage Service WF Config:

{
  “RequestInfo” : {
      “authToken” : “authTokenValue”
   },
  "BusinessServices": [
    {
      "tenantId": "pb",
      "businessService": "ModifySWConnection",
      "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": [
                "SW_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "INITIATED",
          "applicationStatus": "INITIATED",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "SUBMIT_APPLICATION",
              "nextState": "PENDING_FOR_APPROVAL",
              "roles": [
                "SW_CEMP"
              ]
            }
          ]
        },
        {
          "sla": 86400000,
          "state": "PENDING_FOR_APPROVAL",
          "applicationStatus": "PENDING_FOR_APPROVAL",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": true,
          "isTerminateState": false,
          "actions": [
            {
              "action": "APPROVE_CONNECTION",
              "nextState": "APPROVED",
              "roles": [
                "SW_APPROVER"
              ]
            },
            {
              "action": "SEND_BACK",
              "nextState": "INITIATED",
              "roles": [
                "SW_APPROVER"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "SW_APPROVER"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "REJECTED",
          "applicationStatus": "REJECTED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        },
        {
          "sla": null,
          "state": "APPROVED",
          "applicationStatus": "APPROVED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        }
      ]
    }
  ]
}

PDF Templates

Data Config Changes :

ws-bill.json:

Format Config Changes:

Persister Config

https://github.com/egovernments/configs/tree/master/egov-persister/sewerage-persist.yml
- applicationtype, dateeffectivefrom added in the queries against eg_sw_connection table
- New insert and update query added for table eg_sw_connectionholder added for topics “save-sw-connection” and “update-sw-connection”.
- Added locality column in eg_sw_connection table
- Latest file as per v2.2 feature is - https://github.com/egovernments/configs/blob/ec99dd953393cc5307baba5f09f363801bed275e/egov-persister/sewerage-persist.yml
https://github.com/egovernments/configs/tree/master/egov-persister/water-persist.yml
- applicationtype, dateeffectivefrom added in the queries against eg_ws_connection table
- New insert and update query added for table eg_ws_connectionholder added for topics “save-ws-connection” and “update-ws-connection”.
- Added locality column in eg_ws_connection table
- Latest file as per v2.2 feature is - https://github.com/egovernments/configs/blob/5c3ffee5d416d2c083b6b67fd60242b80e558514/egov-persister/water-persist.yml
- https://github.com/egovernments/configs/pull/469/commits/76bc8214a15eacfb604338b2d1e3873b62c0ecd1#diff-4a913383f90cafcd0aed1389888e7322

Indexer Config

Update the indexer file for water and sewerage both. Replace both files as mentioned below.

Egov-Searcher Config

No changes in searcher file

Infra Ops Config

No changes

MDMS Changes

https://github.com/egovernments/egov-mdms-data/pull/1228/commits/d115e2380cf51a25faf6089e087a7c899b4701be

Localisation File

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

Refer the new sheet named “Connection Holder”

Service Builds

Module	Image Details
Billing Service	billing-service:v1.1.1-33b0fcf-14
Property Service	property-services:v1.1.0-c4f9b279-48
PDF Service	pdf-service:v1.1.0-09b11d9
Employee	employee:v1.2.0-64a86d7d2-272
Citizen	citizen:v1.2.0-64a86d7d2-262
WS-Service	ws-services:v1.1.0-28617974-28
WS-Calculator	ws-calculator:v1.1.0-4c3c8873-6
SW-Service	sw-services:v1.1.0-ae23de49-12
SW-Calculator	sw-calculator:v1.1.0-fee435c1-2
Egov-Searcher	egov-searcher:v1.1.0-59d3598
Collection Service	collection-services:v1.1.0-33b0fcf-12
Apportion Service	egov-apportion-service:v1.1.2-3436cd5-4

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 Edit Connection Release

Module	Feature
Citizen	Create a Water / Sewerage connection for property which is belongs to others.
Citizen	Assign others as “Connection Holder” while creating Water / Sewerage Connection
Citizen	Connection Holder will receive all notification (also property owner)
Citizen	Bill & Receipt will be generated in the name of Connection Holder (when a person assigned as Connection Holder).
Citizen	Connection Holder can view the updates of the Application and also Connection details.
Citizen	Search based on Connection Holder’s mobile number
Employee	Assign non-property owner as Connection Holder while applying a new Water / Sewerage connection
Employee	Modify property details for a New Water / Sewerage Connection (if there are no pending due).
Employee	Modify Connection Holder details for a New Water / Sewerage Connection
Backend	Allow adding a Connection Holder for a connection who is not the property owner
Backend	Provide WF progress validation for Modify Connection
Backend	Provide search functionality for ConnectionHolder mobile number
Backend	Restrict Demand generation until the “DateEffectiveFrom” value mentioned in the Modify Connection application
Backend	Restrict creation of new Modify application when the previous application is in-progress
Backend	Send notification to Property Owner as well as Connection Holder if assigned against a Connection