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: