Introduction

The Water and Sewerage Connections module provides a digital interface to apply for water and sewerage connections and, pay the water and sewerage charges for connection/s. It can be used by the citizens, Urban Local Body (ULB) counter employees and field employees, and ULB Administrators to accomplish their specific tasks. It is available as a mobile and web-based application.

Functional Scope

The Water and Sewerage product features can be broadly classified as the following modules:

1. Registration, Login and Creation of User Profile

2. Applying for a new Water/Sewerage connection

3. Searching for a Connection

4. Modifications to a Connection

5. Entering meter reading of metered connections

6. Generate Demand

7. Payment collection and Receipts

8. Closure of water connection

9. Dashboards and Reports

Registration, Login and Creation of User Profile

Application for new Water/Sewerage connection

The system allows the Citizen / ULB user (with an appropriate role in the system) to apply for a New Water/Sewerage connection. The application goes through an approval workflow before it is available for various transactions in the system. The workflow to be followed for a new water/sewerage connection is configurable. In the workflow, the ULB official will generate the estimation notice. Once the payment is made, a work order will be generated.

Every time there is a change in the status of an application, the citizen will be intimated through in-app notifications, SMS and email. The citizen and employee can view the history of the various states that an application has been in and the comments added by the employee in each state of the application.

Searching for a Connection

The employee from the Water & Sewerage department will be able to access the feature, to search for water and sewerage connections. They can search for any connection based on parameters such as:

• Consumer number

• Application number

• Owner mobile number

• Application status

• From date

• To date

The search result contains the application number, Consumer number, Owner name, Status, Due amount and Pay now option. The Employee can make payment for a connection on the citizen’s behalf using the ‘Pay Now’ option.

Citizens can also search for their connection in the portal. They can search using the owner's mobile number, Property ID, Consumer number etc. The search result yields, the Owner’s Name, Address, Due amount and Pay option.

Modifications to a Connection

The system facilitates the title transfer of the water tap connection from one person to the other person. Title transfer of water tap connection directly depends upon Property tax. If title transfer is done in the property tax module then at the time of final approval, the changes will reflect in the W&S module automatically. After the title transfer has been completed successfully, subsequent bills will be generated with the details of the new owner/s.

Water tap change in usage happens when the property type is changed from residential to Non-residential or from Non-residential to residential. Change in usage directly depends on the property tax module. If the property type is changed in the Property tax system then it will automatically reflect in the W&S system. When there is a change in the usage type, the subsequent bills will reflect the rates as per the updated usage category. When there is a change in the usage category in the middle of the billing cycle, pro-rata charges will be applied in the next billing period.

The change in connection category from non-metered to metered and vice-versa is also possible in the W&S system with the appropriate workflow configured to inform all stakeholders of the change and collect any charges (if applicable) from the citizen.

Entering meter readings of metered connections

On the Water & Sewerage Connections billing screen, there is a card called ‘Meter reading’. An employee can click on ‘Meter reading’ which redirects the employee to the meter reading landing screen. The employee can search based on the following criteria:

• ULB

• Boundary Type

• Boundary Value

• Billing Year

• Billing Period

• Billing Period Value

• Consumer No.

This feature facilitates the employee to search for all results based on desired criteria. The search result yields the following values: consumer number, owner name, meter status, last reading, current reading, date and consumption.

The employee can edit meter status, current reading, date and consumption under certain conditions. Based on this information the employee can generate the bills for connections.

Generate Demand

In the system, there is a feature to generate demand under the billing section. Generate demand has a search feature in which, the connections can be searched for which demand has been already generated. An employee can view, also edit those demands based on certain conditions.

The system has the capability to configure the demand generation as an automatic or a manual process. In the automatic process, the demand generation for non-metered connections is automatically done periodically. For a metered connection as soon as the employee enters the meter reading and clicks on ‘SAVE’, the demand is generated.

Any success/ failure to generate demand triggers an automatic notification to the concerned ULB officials via email. Also, the demand generation cycle, demand generation date and officials who should receive the notifications can be configured.

Payments collection and Receipts

The citizen can pay for dues by searching his/her connection. In search results, the citizen can click on pay, which redirects to the summary page of the dues. After this, the citizen can pay for dues online. An employee can also collect the payment on the citizen’s behalf. After searching for the desired connection, clicking on pay will redirect the employee to the common payment page. The employee can print the receipt after the payment is successfully collected. The citizen is also notified and gets a download receipt link in the notification.

Closure of Water Connection

If the Water tap owner has their own water source then the water tap owner can initiate for Water tap connection closure permanently. So, that tap will be closed permanently and demand will not be generated for the connection. Application for the closing of the water tap connection is accepted only with the latest water charges receipt and clearing of old dues.

Dashboards and Reports

The state-level administrator can keep track of relevant metrics by using dashboards. Dashboards for Water & Sewerage can be accessed by a state-level user under login. The dashboard has these components:

• Financial Indicators

  • Water & Sewerage Total collections YTD

  • Water Collection

  • Sewerage Collection

  • Water - Demand vs Collection (Monthly trend)

  • Sewerage - Demand vs Collection (Monthly trend)

• Municipal Adoption

  • W & S: No. Of ULBs Live

  • W & S: Total Number of ULBs

  • Water Consumers by Connection Type

  • W & S Consumers by Usage Type

  • Total Collections by Source

  • Total Collections by Mode

  • W & S Adoption: ULB Wise

• Today’s Collections

  • W&S Total collections: Today

  • Water Charges - Total collections: Today

  • Sewerage Charges - Total collections: Today

  • W&S - Total No. of Receipts: Today

  • Water - Total No. of Receipts: Today

  • Sewerage - Total No. of Receipts: Today

  • Mode-wise W&S collections: Today

  • W&S ULB wise collections: Today

The table below lists the functionalities supported by the offered product as per the recommendations under the guidelines mentioned under the Ease of Doing Business (EODB) guidelines of 2019.

The fee estimate section provides the amount details for applications where payment is pending. The Fee Details displays the amount breakup.

The Water & Sewerage Connections module allows citizens to apply for new connections and pay bills online. For employees, this module enables automated processing of new connection requests, editing existing connection details, generating water bills, and facilitating online collection of bill payments.

Using Water & Sewerage Connections Module

Click on the relevant role below to learn more about how to use the Water & Sewerage Connections solution.

1. Citizens

2. Employees

About Water & Sewerage Connections

The Water & Sewerage Connections module offers a consolidated platform for managing new and existing water and sewerage connections. The module eliminates the need for manual processing and streamlines the key water or sewerage management functions for operational efficiency. DIGIT Water & Sewerage Connections module enables automated processing of new connection requests, generating water bills, and facilitating online bill payment.

Click on the link below to download the water and sewerage connections module brochure.

Key Features

Section Overview

This section contains all docs and information required to understand the module, its key features, functional scope, and configuration details. Click on the links below to learn more about deploying, configuring, customizing, and using the Water & Sewerage Connections module.

Contact Us

The W&S module allows citizens to check the meter readings in case they have metered connections.

The applications that are sent back to citizens for any correction or for the documents to be attached become open for editing at the citizen's end. Applicants have to login into the Citizen Portal to edit the application.

Counter Employee (CE)

The Counter Employee (CE) represents the ULB employee responsible for assisting the citizens with water and sewerage connection-related activities. The W&S module provides the CE with the scope to submit applications for new connections on behalf of the citizens or collect payment for the citizen bills at the counter.

The CE can -

1. Apply for new connections

2. Search applications/connections

3. Add meter readings

4. Activate new connections

5. Pay water or sewerage bills

6. Add rebate or penalty to bills

7. Modify connection details

Employee Home Page

The home page below is displayed once the employee logs onto the system.

Employee Inbox

Click on the Inbox menu to access the employee inbox.

The top feature menus are displayed on the left side. The filter panel on the left bottom displays the search filters.

1. Assigned to Me - The only applications assigned to the logged-in user are displayed on the right side window.

2. Assigned to All - It is default selected and hence the applications assigned to anyone are displayed on the right side window.

3. Locality - It filters the application based on the locality selected and then displays the result on the right side window.

4. Application Type - It filters the application based on the application type selected and then displays the result on the right side window.

5. Application Status - It appears only when the application type filter is selected and filters the application based on the application status selected and then displays the result on the right side window.

The search parameters are displayed on the top right. This allows users to search the application by Application Number, Consumer Number, and Consumer’s/ Applicant’s Mobile Number.

The window on the bottom right side provides the list of applications based on the default settings or applied filters and search parameters.

The citizen portal lets users view their connection details and pay water or sewerage bills online.

Citizens can view past bill payment details from their portal.

Citizens can view their applications to find status details, pending fees to be paid, or any other notifications linked to the application.

The Apply for New Connection option allows citizens to submit their applications for new water or sewerage connections. Application forms are submitted through the DIGIT Citizen Portal for further processing and approval for new connections by the ULB employees.

Citizens represent individuals, groups or communities using the W&S module online to manage their water and sewerage connections. The W&S module allows citizens to apply for new connections, pay bills online, and view past payments and connection and application details.

The DIGIT citizen portal lists all citizen-centric services as well as the Information and Updates from the ULBs. Click on the View All button on the card to view the list of available citizen services.

The citizens can -

Search and Pay service enables citizens to pay the water and sewerage charges dues without logging into the account.

Consumers can either search and pay their bills or they can access their bills by logging in to their registered account. Follow the steps below to search and pay the bills.

Search & Pay

The CEs can apply for new water or sewerage connection applications and submit it on behalf of the citizens.

To apply for new connections -

Click on the Water & Sewerage menu option in the sidebar or the Water & Sewerage card on the DIGIT home page.

The owner of a water or sewerage connection can apply for disconnection if the service is no longer in use now or due to any other reason.

CEs add the meter readings for each connection to generate monthly bills based on the recorded usage.

To add meter readings -

Search for the specific connection using relevant search parameters. Click on the Consumer Number link available for listed connections. Click on View Consumption Details available in the Service Details panel.

Click on the Add Meter Reading button on the top right corner of the Consumption Details page.

The Billing Period by default is set to the last reading date and current reading date.

Select the applicable Meter Status. The meter status can be changed to reflect the current working condition of the meter. Meters can be set to Working, Locked, Breakdown, Non-meter, Reset, or Replacement, as applicable.

Enter the Current Reading on the meter reading page. The system displays the Last Reading and the Last Reading Date. Enter the Current Reading Date. The date field auto-populates the current date by default.

The actual Consumption is automatically calculated by the system. The customer is billed based on the actual consumption.

Click on the Save button to save the reading. This will generate the bill or demand for payment that has to be made by the customer.

The employee user can edit application details on behalf of the applicants.

To edit applications -

The applications Pending for Document Verification are available on the home page. Else, search for the application using the search parameters.

Open the application. Click on the View History button available in the Task Status panel on top to view the list of actions taken on the application so far. Click on the View Breakup button to find the fee breakup details in the Fee Estimate panel.

Click on the Add Rebate/Penalty button to add any ad hoc penalty or rebate amount to the total fee payable. Scroll down the application to review the filled-in details. Click on the View button for each uploaded document to review details.

Click on the Take Action button and then click on Edit to make the required corrections. Review the Connection Details and the list of Documents furnished with the application.

Enter the connection details in the Additional Details section of the application. Select the applicable Connection Type. Enter the Number of Taps, Water Source, Water Sub Source, and Pipe Size details.

Select ULB if the plumber is provided by the ULB. Else, check the Self option. In case the plumber is provided by the ULB enter the Plumber License No., Plumber Name, and Plumber Mobile No. details.

Select the relevant Road Type. Enter the Area (in sq ft) to indicate the length of road cutting required to lay the pipes. Enter the Connection Execution Date. The connection will be activated on the specified date.

Click on Next Step in the Summary section of the application. Review the application details. Complete the changes and click on the Submit button to save the changes.

The W&S portal enables CEs and other ULB employees to search for specific applications or connections using different search parameters.

To search for W&S connections -

Click on the Water & Sewerage menu option in the sidebar or the Water & Sewerage card on the DIGIT home page. The Search Connections tab on the page displays the various search parameters that filter the search for specific connections. Enter the applicable City. This is a mandatory search filter.

Enter the Property ID or Owner Mobile No. or Consumer Number or the Old Consumer Number to filter the view of connections based on the specified parameter. Click on the Search button to view the search results. Click on the Reset button to renew the search using different parameters.

To search for W&S applications -

Click on the Water & Sewerage menu option in the sidebar or the Water & Sewerage card on the DIGIT home page. Click on the Search Applications tab.

Enter the Consumer No. or Application Number or Owner Mobile No. or Application Type to filter the search for applications. The application search can also be filtered by Application Status or by defining a specific period in the From Date and To Date fields. The system fetches the applications created between the specified period or after the specified date.

Click on the Search button to view the search results. Click on the Reset button to renew the search using different parameters.

The employee user can send the application back to the citizen for any corrections or if any vital document has not been uploaded.

To send the application back to the citizen -

Enter the Application No. or any other search parameter to search for the application. Click on the Application No. link to open the application. Scroll down the application page to review the filled-in details.

Click on the View File button to open the documents uploaded in the application. Click on the Take Action button at the bottom of the application page once the review is complete. Click on the Send Back to Citizen button if the documents do not meet the application requirements or if any document is missing.

State the reasons for sending the application back to the citizen in the Comments section. Click on the Upload Files button to upload any supporting documents. Click on the Send Back button.

The application is placed back in the Citizen queue for required edits.

Once the application for new water or sewerage connection is approved and the citizen has paid the applicable connection charges, the CE is responsible for activating the new connection.

To activate new connections -

Search for the applications that are Pending for Connection Activation. Click on the Application No. to open the application.

Click on the Take Action button and click on the Edit option to enter connection activation details.

Review the Connection Details and the list of Documents furnished with the application.

Enter the connection details in the Additional Details section of the application.

Enter the Connection Execution Date. The connection will be activated on the specified date. For metered connections, enter the Meter ID, Meter Installation Date, and Initial Meter Reading (KL).

Click on Next Step in the Summary section of the application. Review the application details. Click on the Take Action button and then click on the Activate Connection option.

Enter any Comments for activating the connection. Click on the Activate Connection button.

The connection activation success message is displayed on the screen. A system generates a unique Consumer No. to identify the connection.

The employee user verifies and forwards the application if the documents and information provided in the application are found satisfactory and complete.

To verify and forward the application -

Click on the Take Action button at the bottom of the application page once the review is complete. Click on the Verify and Forward button once all documents are verified.

Select the applicable Assignee Name who will carry out the next phase of verification. Provide any additional information for the assignee in the Comments section. Click on the Upload Files button to upload any supporting documents. Click on the Verify and Forward button.

The application is forwarded to the field inspector for further processing.

CEs can pay W&S bills for the citizens. The CEs can add penalties or rebates to the bill amount depending on the applicable penalties or rebates available for the customers.

To pay bills -

Enter the relevant search parameter to filter the view of W&S connections. Click on the Collect button for the specific connection.

The Bill Details panel displays the pending dues details and its breakup.

Click on the Add Rebate/Penalty button to adjust any penalties or rebates applicable for the customer.

Add the Adhoc Penalty Amount or the Adhoc Rebate Amount. Select the Reason For Adhoc Penalty or Reason for Adhoc Rebate from the given drop-down list. Enter any additional information in the Enter Comments section.

Click on the Add button to add the penalty or rebate amount to the total bill amount. Click on the Download Bill button to download the bill. Click on the Pay button.

Select Full Amount or Custom Amount to specify the full or partial payment of the bill. Enter the Amount to Pay if Custom Amount is selected. Click on the applicable payment tab in the Capture Payment panel.

Enter the required payment details and make the payment. Click on the Generate Receipt button to process the payment.

The payment success acknowledgement message is displayed on the screen. Click on the Download or Print button to download or print the payment receipt.

The employee user can reject the application if the documents and information furnished by the citizen do not meet the prescribed guidelines.

To reject the application -

Click on the Take Action button at the bottom of the application page once the review is complete. Click on the Reject button if the documents do not meet the application requirements or the information provided in the application is inaccurate.

State the reasons for rejecting the application in the Comments section. Click on the Upload Files button to upload any supporting documents. Click on the Reject button.

The application is rejected and a notification is sent to the applicant informing the same.

The W&S module enables CEs to make any changes to the existing water or sewerage connection details in a few simple steps. Such changes may reflect any updates in property details or connection details.

To modify connection details -

Search for the specific connection using applicable search parameters. Click on the Consumer Number link to open the connection details page.

Scroll down the page and click on the Take Action button. Click on Modify Connection.

The Modify Connection application form contains 4 sections. The Property Details panel displays the existing property details linked to the connection. Click on the Search Property button to replace the existing property details with another property. Select the applicable Property ID. The change request for property details will be forwarded to the Approver for final approval.

Click on the Modify Property button to make any changes to the existing property. This action is integrated with the Property Tax module. So, whatever changes or edits are requested for the listed property will go through the Edit Property workflow for verification and final approval from the Property Tax department.

Click on the Next Step button to move to the Additional Details section.

Change the Connection Details as required on this page. Users can modify the existing Connection Type, Number of Taps, Water Source, Water Sub Source, and applicable Pipe Size details. Change the Activation Details if required. Enter new meter details in the Meter ID and Meter Installation Date fields.

Enter the Modification Effective From date. The requested changes will be reflected on the selected date. Click on the Next Step button to upload supporting documents for the requested changes.

Select the applicable Documents and then click on Upload Files to attach the selected documents to the application.

Click on the Next Step button to move to the Summary page of the application. Scroll down the page to review the modification requests. The existing connection details are available below the requested changes for easy reference.

Click on the Submit button to process the modification requests. The application is sent to the Approver for final approval.

Citizens can view their water or sewerage connection details through the portal.

The Approver verifies the application and if the documents and information provided in the application are found satisfactory and complete, the connection request is approved.

To approve connections -

Click on the Take Action button at the bottom of the application page once the review is complete. Click on the Approve Connection button once the application is reviewed and verified.

Provide any additional information for the applicant in the Comments section. Click on the Upload Files button to upload any supporting documents. Click on the Approve Connection button.

The application for a new water or sewerage connection is approved. The applicant is allotted a unique Consumer Number. The application is now routed back to the citizen to make the payment towards connection charges. Once the payment is done the connection is activated.

Introduction

Water Charges are levied for metered connections based on consumption. The rate for calculation of water charges varies widely and is dependent upon various parameters. In the DIGIT W&S module, water charges defined are based on actual consumption and property usage type.

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.

3. Please reach out to the person who has shared this template with you to discuss and clear your doubts.

4. Select the property type from the drop-down list available in the Property Usage Type column.

5. Enter the Slab (water consumed) range details in the From and To Value for water consumed.

6. Enter the Rate for the specified slab range and property type.

7. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

A separate Entity Specific Checklist is not required for this module data.

Attachments

Introduction

Water pipes are available in different sizes. Pipe size is a common parameter used for calculating water charges. The allotted pipe size for new water connections depends on specific service requirements.

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to understand the headers in the template sheet, their data type, size, and definitions.

3. Reach out to the person who shared the template for further details or to clear your doubts. Identify if the State/ULB has a provision for capturing pipe size for connections.

4. Enter the Pipe Size details.

5. Enter the corresponding UOM for the specified Pipe Size.

6. Go through the checklist to verify the data. Make sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per specifications. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

A separate entity-specific checklist is not needed for this module data.

Attachments

Introduction

The Water Charges module offers a consolidated platform for managing new and existing water connections. The module eliminates the need for manual processing and streamlines the key water management functions for operational efficiency. DIGIT Water & Sewerage (W&S) module enables automated processing of new connection requests, generating water bills, and facilitating online payment of bills.

Module Features

DIGIT Water Charges module enables citizens to -

1. Apply for new water connections.

2. Upload documents required for processing new connections.

3. Pay water connection charges and water bills using an online payment gateway.

4. Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation.

5. Download water connection approval letter, payment receipts, and bills online.

DIGIT Water module enables employees at ULB and State level to -

1. Process applications using customizable workflows.

2. Configure water charges, interest, and penalty calculation logic.

3. View custom dashboards for module statistics.

4. Filter search results using advanced configurable search parameters.

Module Ontology

State Level

None

ULB Level

Module Reports

None

Introduction

The penalty is levied on the consumer in case the consumer fails to make the payment for the bill raised before the specified due date. The consumer has to make the full payment before the due date to avoid penalty charges. The number of days after which the penalty is applicable is configurable at the ULB level. The penalty calculation logic may differ from one state or ULB to another.

The penalty can be -

1. Fixed amount

2. Percentage: When it is a percentage, it can be levied on

   1. Entire bill amount

   2. Balance pending when partial payments have been made

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.

3. Please reach out to the person who has shared this template with you to discuss and clear your doubts.

4. Enter an appropriate value for Penalty Based On.

5. Enter a value for the Grace Period.

6. Enter the Penalty Flat Amount.

7. Enter the Penalty value in percent.

8. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

Separate Entity Specific Checklist is not required for this module data.

Attachments

Overview

We are using re-indexing to get all the data to the respective indexer. We have 2 steps for this. The first is to run the connector from the playground. This is followed by a legacy indexer service call from the indexer service, which internally calls the respective plain search service to get the data and send it to the respective indexer.

Pre-requisites

• Access to kubectl of the environment targetted

• Postman scripts

• Plain search APIs in the respective services

Configuration Steps

We have two services for water and sewerage

• water-services

• sewerage-services

Water-services Reindexing Steps

• Connect to playground pod.

• Delete the Kafka connector if already exists with the Kafka connection, using the below command through playground pod.

curl --location --request DELETE 'http://kafka-connect.kafka-cluster:8083/connectors/water-services-enriched-es-sink'

• Run below Kafka connector curl from playground pod:

curl --location --request POST 'http://kafka-connect.kafka-cluster:8083/connectors/' \
--header 'Cache-Control: no-cache' \
--header 'Content-Type: application/json' \
--header 'Postman-Token: 419e68ba-ffb9-4da9-86e1-7ad5a4c8d0b9' \
--data '{
    "name": "water-services-enriched-es-sink",
    "config": {
        "connector.class": "io.confluent.connect.elasticsearch.ElasticsearchSinkConnector",
        "type.name": "general",
        "tasks.max": "1",
        "max.retries": "15",
        "key.ignore": "false",
        "retry.backoff.ms": "5000",
        "max.buffered.records": "25",
        "value.converter": "org.apache.kafka.connect.json.JsonConverter",
        "errors.log.enable": "true",
        "key.converter": "org.apache.kafka.connect.storage.StringConverter",
        "read.timeout.ms": "100000",
        "topics": "water-services-enriched",
        "batch.size": "25",
        "max.in.flight.requests": "2",
        "schema.ignore": "true",
        "behavior.on.malformed.documents": "warn",
        "flush.timeout.ms": "3600000",
        "errors.deadletterqueue.topic.name": "water-services-enriched-failed",
        "errors.tolerance": "all",
        "value.converter.schemas.enable": "false",
        "name": "water-services-enriched-es-sink",
        "connection.url": "http://elasticsearch-data-v1.es-cluster:9200",
        "linger.ms": "1000",
        "transforms": "TopicNameRouter",
        "transforms.TopicNameRouter.type": "org.apache.kafka.connect.transforms.RegexRouter",
        "transforms.TopicNameRouter.regex": "water-services-enriched*",
        "transforms.TopicNameRouter.replacement": "water-services-enriched"
    }
}'

• port forward to egov-indexer pod and run below curl throw postman.

curl --location --request POST 'http://localhost:8088/egov-indexer/index-operations/_legacyindex' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RequestInfo": {
        "apiId": "string",
        "ver": "string",
        "ts": null,
        "action": "string",
        "did": "string",
        "key": "string",
        "msgId": "string",
        "authToken": "ca3256e3-5318-47b1-8a68-ffcf2228fe35",
        "correlationId": "e721639b-c095-40b3-86e2-acecb2cb6efb",
        "userInfo": {
            "id": 23299,
            "uuid": "e721639b-c095-40b3-86e2-acecb2cb6efb",
            "userName": "9337682030",
            "name": "Abhilash Seth",
            "type": "CITIZEN",
            "mobileNumber": "9337682030",
            "emailId": "abhilash.seth@gmail.com",
            "roles": [
                {
                    "id": 281,
                    "name": "Citizen"
                }
            ]
        }
    },
    "apiDetails": {
        "uri": "http://ws-services.egov:8080/ws-services/wc/_plainsearch",
        "tenantIdForOpenSearch": "pb",
        "paginationDetails": {
            "offsetKey": "offset",
            "sizeKey": "limit",
            "maxPageSize": 25,
            "limit": 25
        },
        "responseJsonPath": "$.WaterConnection"
    },
    "legacyIndexTopic": "ws-connection-legacyIndex",
    "tenantId": "pb"
}'

• Delete the Kafka connection after all the data has been re-indexed by following the below command through the playground pod.

curl --location --request DELETE 'http://kafka-connect.kafka-cluster:8083/connectors/water-services-enriched-es-sink'

• Alias water-services-enriched as water-services through the Kibana server.

POST /_aliases 
{
  "actions": [
    {
      "add": {
        "index": "water-services-enriched",
        "alias": "water-services"
      }
    }
  ]
}

Sewerage-services Reindexing Steps

• Connect to playground pod.

• Delete the Kafka connector if already exists with the Kafka connection, using the below command through playground pod.

curl --location --request DELETE 'http://kafka-connect.kafka-cluster:8083/sewerage-services-enriched-es-sink'

• Run below Kafka connector curl from playground pod:

curl --location --request POST 'http://kafka-connect.kafka-cluster:8083/connectors/' \
--header 'Cache-Control: no-cache' \
--header 'Content-Type: application/json' \
--header 'Postman-Token: 419e68ba-ffb9-4da9-86e1-7ad5a4c8d0b9' \
--data-raw '{
    "name": "sewerage-services-enriched-es-sink",
    "config": {
        "connector.class": "io.confluent.connect.elasticsearch.ElasticsearchSinkConnector",
        "type.name": "general",
        "tasks.max": "1",
        "max.retries": "15",
        "key.ignore": "false",
        "retry.backoff.ms": "5000",
        "max.buffered.records": "25",
        "value.converter": "org.apache.kafka.connect.json.JsonConverter",
        "errors.log.enable": "true",
        "key.converter": "org.apache.kafka.connect.storage.StringConverter",
        "read.timeout.ms": "100000",
        "topics": "sewerage-services-enriched",
        "batch.size": "25",
        "max.in.flight.requests": "2",
        "schema.ignore": "true",
        "behavior.on.malformed.documents": "warn",
        "flush.timeout.ms": "3600000",
        "errors.deadletterqueue.topic.name": "sewerage-services-enriched-failed",
        "errors.tolerance": "all",
        "value.converter.schemas.enable": "false",
        "name": "sewerage-services-enriched-es-sink",
        "connection.url": "http://elasticsearch-data-v1.es-cluster:9200",
        "linger.ms": "1000",
        "transforms": "TopicNameRouter",
        "transforms.TopicNameRouter.type": "org.apache.kafka.connect.transforms.RegexRouter",
        "transforms.TopicNameRouter.regex": "sewerage-services-enriched*",
        "transforms.TopicNameRouter.replacement": "sewerage-services-enriched"
    }
}'

• port forward to egov-indexer pod and run below curl throw postman.

curl --location --request POST 'http://localhost:8088/egov-indexer/index-operations/_legacyindex' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RequestInfo": {
        "apiId": "string",
        "ver": "string",
        "ts": null,
        "action": "string",
        "did": "string",
        "key": "string",
        "msgId": "string",
        "authToken": "ca3256e3-5318-47b1-8a68-ffcf2228fe35",
        "correlationId": "e721639b-c095-40b3-86e2-acecb2cb6efb",
        "userInfo": {
            "id": 23299,
            "uuid": "e721639b-c095-40b3-86e2-acecb2cb6efb",
            "userName": "9337682030",
            "name": "Abhilash Seth",
            "type": "CITIZEN",
            "mobileNumber": "9337682030",
            "emailId": "abhilash.seth@gmail.com",
            "roles": [
                {
                    "id": 281,
                    "name": "Citizen"
                }
            ]
        }
    },
    "apiDetails": {
        "uri": "http://sw-services.egov:8080/sw-services/swc/_plainsearch",
        "tenantIdForOpenSearch": "pb",
        "paginationDetails": {
            "offsetKey": "offset",
            "sizeKey": "limit",
            "maxPageSize": 25,
            "limit":25
        },
        "responseJsonPath": "$.SewerageConnections"
    },
    "legacyIndexTopic": "sw-connection-legacyIndex",
    "tenantId": "pb"
}'

• Delete the Kafka connection after all the data has been re-indexed by following the below command through the playground pod.

curl --location --request DELETE 'http://kafka-connect.kafka-cluster:8083/sewerage-services-enriched-es-sink'

• Alias water-services-enriched as water-services through the Kibana server.

POST /_aliases 
{
  "actions": [
    {
      "add": {
        "index": "sewerage-services-enriched",
        "alias": "sewerage-services"
      }
    }
  ]
}

Introduction

There are two reasons for recording the water source. One is to measure availability vs consumption. And, the other is to monitor the water quality. Each ULB captures this information. Hence, the water source details are configurable at the ULB level. ULBs can configure water source data at two levels - water source and water sub source.

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document for more details on data type, size, and definitions.

3. Contact the person who shared this template with you to discuss and clear your doubts.

4. Enter the relevant Water Source.

5. Enter the corresponding Water Sub Source. This will map the water sub source to the specified water source.

6. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist is a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

A separate Entity Specific Checklist is not required for this module data.

Attachments

Introduction

Water Charges are recurring charges levied for a pre-defined billing period. The billing period is configurable as per the state or ULB requirement. The rate for calculation of water charges vary widely and is dependent upon various parameters. Charges for water are dependent upon either plot size slab or No. of taps combined with property usage type. In some cases, they can also be solely dependent upon the property usage type.

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.

3. Please reach out to the person who has shared this template with you to discuss and clear your doubts.

4. Select the property type from the drop-down list available in the Property Usage Type column.

5. Enter the Slab (property size value) range details in the From and To Value for property size.

6. Enter the value for No. of Taps. The water charges will be calculated on the number of taps.

7. Enter the Rate or the per-unit water consumption charges that will be applicable for the listed parameters.

8. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

Separate Entity Specific Checklist is not required for this module data.

Attachments

Introduction

Interest is levied from the consumer in case the consumer fails to make the payment of the bill before the specified due date. The consumer has to make the full payment before the due date to avoid interest charges. The number of days after which the interest is applicable is configurable at the ULB level. Interest Rates are calculated essentially on a daily percentage basis.

The interest rate on a daily basis can be levied on -

1. Entire bill amount

2. Balance pending when partial payments have been made

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.

3. Please reach out to the person who has shared this template with you to discuss and clear your doubts.

4. Enter the Grace Period.

5. Select the relevant Interest-based On parameter.

6. Enter the Interest Rate.

7. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

Separate Entity Specific Checklist is not required for this module data.

Attachments

Introduction

Interest is levied on the consumer if the consumer fails to make the bill payment before a specified due date. The consumer has to make the full payment before the due date to avoid interest charges. The number of days after which the interest is applicable is configurable at the ULB level. The interest amount is charged to the consumer on a daily basis once the specified grace period is over and till the bill payment is done.

Interest rate: The interest rate on a daily basis can be levied on -

1. Entire bill amount

2. Balance pending when partial payments have been made

Data Table

Data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.

3. Please reach out to the person who has shared this template with you to discuss and clear your doubts.

4. Enter the applicable Grace Period for calculating interest.

5. Select the relevant parameter for Interest-Based On to specify if the interest is applied to the bill amount or pending balance.

6. Enter the applicable percentage value for Interest Rate that will be used to calculate the interest amount.

7. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

Separate Entity Specific Checklist is not required for this module data.

Attachments

Introduction

The Sewerage Charges module offers a consolidated platform for managing new and existing sewerage connections. The module eliminates the need for manual processing and streamlines the key sewerage management functions for operational efficiency. DIGIT Water & Sewerage (W&S) module enables automated processing of new connection requests, generating water bills, and facilitating online payment of bills.

Module Features

DIGIT Sewerage Charges module enables citizens to -

1. Apply for new sewerage connections.

2. Upload documents required for processing new connections.

3. Pay sewerage connection charges and bills using online payment gateway.

4. Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation.

5. Download sewerage connection approval letter, payment receipts, and bills online.

DIGIT Sewerage module enables employees at ULB and State level to -

1. Process applications using customizable workflows.

2. Configure sewerage charges, interest, and penalty calculation logic.

3. View custom dashboards for module statistics.

4. Filter search results using advanced configurable search parameters.

Module Ontology

State Level

None

ULB Level

Module Reports

None

Overview

Water Calculator Service is used for creating meter reading, searching meter reading, updating existing meter reading, calculation of water charge, demand generation, SMS & email notification to ULB officials on-demand generation and estimation of water charge(one-time cost) which involves cost like road-cutting charge, form fee, scrutiny fee, etc.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

• Java 8

• Kafka server is up and running

• egov-persister service is running and has water service persister configs path added in it

• PSQL server is running and a database is created to store water connection / application data

• Following services should be up and running:

  • egov-perister

  • egov-mdms

  • ws-services

  • billing-service

Key Functionalities

• Calculate water charge and taxes based on billing slab.

• Calculate meter reading charge for water connection

• Generate demand

• Scheduler for generating the demand(for non metered connection)

Deployment Details

1. Deploy the latest version of ws-service and ws-calculator

2. Add water-persist.yml & water-meter.yml file in config folder in git and add that path in persister . (The file path is to be added in environment yaml file in param called persist-yml-path )

Configuration Details

MDMS Configuration

Billing Slabs:

Criteria :

1. connection type

2. building type

3. calculation attribute

4. property usage type

{
      "id": "1",
      "buildingType": "RESIDENTIAL",
      "connectionType": "Metered",
      "calculationAttribute": "Water consumption",
      "minimumCharge": 100,
      "slabs": [
        {
          "from": 0,
          "to": 10,
          "charge": 2,
          "meterCharge": 50
        },
        {
          "from": 10,
          "to": 20,
          "charge": 2.5,
          "meterCharge": 50
        },
        {
          "from": 20,
          "to": 30,
          "charge": 8,
          "meterCharge": 150
        },
        {
          "from": 30,
          "to": 40,
          "charge": 12,
          "meterCharge": 150
        },
        {
          "from": 40,
          "to": 1000000000,
          "charge": 15,
          "meterCharge": 150
        }
      ]
    }

If all criteria will match for that water connection this slab will use for calculation.

Estimation

For application one-time fee, the estimation will return all the related tax head based on criteria. For estimation, all configuration is present in ws-services-calculation.

All the above master configuration is used for estimation.

Following are the exemptions and taxes that are calculated:

• Form fee

• Scrutiny fee

• Meter charge (For metered connection)

• Other charges

• Road cutting charges

• One time fee

• Security charges

• Tax and cess

Water Charge and Tax

Water charge is based on billing slab, for water application charge will be based on slab and tax based on master configuration.

Interest

Below is a sample of master data JSON for interest :

{
  "tenantId": "pb",
  "moduleName": "ws-services-calculation",
  "Interest": [
    {
      "rate": 5,
      "minAmount": null,
      "applicableAfterDays":0,
      "flatAmount": null,
      "maxAmount": null,
      "fromFY": "2019-20",
      "startingDay": "1/01/2019"
    }
  ]
}

Penalty

Below is a sample of master data JSON for penalty :

{
  "tenantId": "pb",
  "moduleName": "ws-services-calculation",
  "Penalty": [
    {
      "rate": 10,
      "minAmount": null,
      "applicableAfterDays": 0,
      "flatAmount": null,
      "fromFY": "2019-20",
      "startingDay": "1/01/2019"
    }
  ]
}

Round Off

If the fraction is greater than equal to 0.5 the number is round up else it’s round down. eg: 100.4 will be rounded to 100 while 100.6 will be rounded to 101.

Actions & Role Action Mapping

Actions

[
  {
      "id": {{PLACEHOLDER1}},
      "name": "Enter Meter Reading",
      "url": "/ws-calculator/meterConnection/_create",
      "displayName": "Enter Meter Reading",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-calculator",
      "code": "null",
      "path": ""
    },
    {
      "id": {{PLACEHOLDER2}},
      "name": "Search Meter Reading",
      "url": "/ws-calculator/meterConnection/_search",
      "displayName": "Search Meter Reading",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-calculator",
      "code": "null",
      "path": ""
    },
    {
      "id": {{PLACEHOLDER3}},
      "name": "Calculate Water Bill",
      "url": "/ws-calculator/waterCalculator/_calculate",
      "displayName": "Calculate Water Bill",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-calculator",
      "code": "null",
      "path": ""
    },
    {
      "id": {{PLACEHOLDER4}},
      "name": "Calculate Fee For Water Application",
      "url": "/ws-calculator/waterCalculator/_estimate",
      "displayName": "Fee Calculation For Water Application",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-calculator",
      "code": "null",
      "path": ""
    },
    {
      "id": {{PLACEHOLDER5}},
      "name": "Add adhoc tax",
      "url": "/ws-calculator/waterCalculator/_applyAdhocTax",
      "displayName": "Add adhoc tax",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-calculator",
      "code": "null",
      "path": ""
    }
]

Role Action Mapping

[
    {
      "rolecode": "WS_CEMP",
      "actionid": {{PLACEHOLDER1}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_CEMP",
      "actionid": {{PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "CITIZEN",
      "actionid": {{PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_CEMP",
      "actionid": {{PLACEHOLDER3}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_CEMP",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_CLERK",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_DOC_VERIFIER",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_FIELD_INSPECTOR",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_APPROVER",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "CITIZEN",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_CEMP",
      "actionid": {{PLACEHOLDER5}},
      "actioncode": "",
      "tenantId": "pb"
    }

]

Demand Generation

Once water is sent to the calculator, its tax estimates are calculated. Using these tax head estimates demand details are created. For every tax head, the estimated demand generates function will create a corresponding demand detail.

Whenever _calculate API is called demand is first searched based on the connection no or application no and the demand from and to period. If demand already exists the same demand is updated else new demand is generated with consumer code as connection no or application no and demand from and to a period equal to financial year start and end period.

In the case of an update, if the tax head estimates change, the difference in amount for that tax head is added as new demand detail. For example, if the initial demand has one demand detail with WATER_CHARGE equal to 120

"demandDetails": [
                {
                    "id": "77ba1e93-a535-409c-b9d1-a312c409bd45",
                    "demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
                    "taxHeadMasterCode": "WATER_CHARGE",
                    "taxAmount": 120,
                    "collectionAmount": 120,
                    "additionalDetails": null,
                    "auditDetails": {
                        "createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "createdTime": 1583675275873,
                        "lastModifiedTime": 1583675298705
                    },
                    "tenantId": "pb.amritsar"
                }
            ],

After updating if the WATER_CHARGE increases to 150 we add one more demand detail to account for the increased amount. The demand detail will be updated to:

"demandDetails": [
                {
                    "id": "77ba1e93-a535-409c-b9d1-a312c409bd45",
                    "demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
                    "taxHeadMasterCode": "WATER_CHARGE",
                    "taxAmount": 120,
                    "collectionAmount": 0,
                    "additionalDetails": null,
                    "auditDetails": {
                        "createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "createdTime": 1583675275873,
                        "lastModifiedTime": 1583675298705
                    },
                    "tenantId": "pb.amritsar"
                },
                {
                    "id": "0d83f4b0-6442-11ea-bc55-0242ac130003 ",
                    "demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
                    "taxHeadMasterCode": "WATER_CHARGE",
                    "taxAmount": 30,
                    "collectionAmount": 0,
                    "additionalDetails": null,
                    "auditDetails": {
                        "createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "createdTime": 1583675275873,
                        "lastModifiedTime": 1583675298705
                    },
                    "tenantId": "pb.amritsar"
                }
            ],

RoundOff is bill based i.e every time bill is generated round off is adjusted so that the payable amount is the whole number. Individual WS_ROUNDOFF in demand detail can be greater than 0.5 but the sum of all WS_ROUNDOFF will always be less than 0.5.

Scheduler for generating the demand (For non metered connection):

Description :

For generating the demand for non metered connection we have a feature for generating the demand in batch. The scheduler is responsible for generating the demand based on the tenant.

• The scheduler can be hit by scheduler API or we can schedule cron job or we can put config to kubectl which will hit scheduler based on config.

• After the scheduler been hit we will search the list of the tenant (city) present in the database.

• After getting the tenants we will pick up tenant one by one and generate the demand for that tenant.

• We will load the consumer codes for the tenant and push the calculation criteria to Kafka. Calculation criteria contain minimal information (We are not pushing large data to Kafka), calculation criteria contain consumer code and one boolean variable.

• After pushing the data into Kafka we are consuming the records based on the batch configuration. Ex:-> if the batch configuration is 50 so we will consume the 50 calculation criteria at a time.

• After consuming the record(Calculation criteria) we will process the batch for generating the demand. If the batch is successful so will log the consumer codes which have been processed.

• If some records failed in batch so we will push the batch into dead letter batch topic. From the dead letter batch topic, we will process the batch one by one.

• If the record is successful we will log the consumer code, If the record is failed so we will push the data into a dead letter single topic.

• Dead letter single topic contains information about failure records in Kafka.

Use cases:

1. If the same job trigger multiple time what will happen?

If the same job triggers multiple times we will process again as mentioned above but at the demand level we will check the demand based on consumer code and billing period, If demand already exists then we will update the demand otherwise we will create the demand.

1. Are we maintaining success or failure status anywhere?

Currently, we are maintaining the status of failed records in Kafka.

Configuration :

We need to configure the batch size for Kafka consumer. This configuration is for how much data will be processed at a time.1ws.demand.based.batch.size=10

Integration

Integration Scope

ws-calculator will be integrated with ws-service. ws-services internally invoke the ws-calculator service to calculate and generate demand for the charges.

Integration Benefits

WS calculator application is used to calculate the water application one time Fees and meter reading charges based on the different billing slabs that's why the calculation and demand generation logic will be separated out from the WS service. So in future, if calculation logic needs to modify then changes can be carried out for each implementation without modifying the WS service.

Steps to Integration

1. Once the water connection is activated for metered-connection, employee can add meter reading details using this API - /ws-calculator/meterConnection/_createwhich in-turn will generate the demand. For the Non-Metered connections, the scheduler APIs need to be called periodically to generate the demand.

2. For the Metered Connection service, to get the previous meter reading /meterConnection/_search API is used.

3. To Activate the Water Service application, the user needs to pay the ONE_TIME_FEE for the connection. To calculate the ONE_TIME_FEE /waterCalculator/_estimate API is used.

4. To generate the demand for metered or non-metered water connection /waterCalculator/_calculate API is used.

5. User can pay partial / full / advance amount for the Metered or Non-Metered connection bill. In these cases, Billing service would call back /waterCalculator/_updateDemandAPI to update the details of the demand generated.

6. /waterCalculator/_jobscheduler API is use to generate demand for Non-metered connections. This API can be called periodically.

7. /waterCalculator/_applyAdhocTax API is used to add Rebate or Penalty on any bill and based on that the bill amount will be adjusted.

Reference Docs

Doc Links

API List

(Note: All the API’s are in the same postman collection therefore same link is added in each row)

__

__

Introduction

The penalty is levied on the consumer if the consumer fails to make the payment for the bill raised before a specified due date. The consumer has to make the full payment before the due date to avoid penalty charges. The number of days after which the penalty is applicable should be configurable at the ULB level.

The penalty can be -

1. Fixed amount; or

2. Percentage: In case of percentage, it can be levied on either

   1. Entire bill amount; or

   2. Balance pending when partial payments have been made

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.

3. Please reach out to the person who has shared this template with you to discuss and clear your doubts.

4. Enter the applicable value for the Grace Period.

5. Enter the corresponding Penalty Flat Amount.

6. Select the relevant parameter for Penalty Based On to specify if the calculation of the penalty is based on the bill amount or the pending balance.

7. Enter the applicable percentage value for calculating the Penalty amount.

8. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

Separate Entity Specific Checklist is not required for this module data.

Attachments

Overview

Water Calculator Service is used for creating meter readings, searching meter readings, updating existing meter readings, calculation of water charges, demand generation, SMS & email notification to ULB officials on-demand generation and estimation of water charge on basis of meter reading for existing water application until the application is disconnected.

Configuration Details

MDMS Configuration

There are no additional billing slabs to be configured for water disconnection, the calculation happens with the meter reading if added and uses existing billing slabs.

Billing Slabs

Criteria -

1. connection type

2. building type

3. calculation attribute

4. property usage type

The combination of the above can be used to define the billing slab. Billing Slab is defined in MDMS under ws-services-calculation folder with the . The following is the sample slab.

{
      "id": "1",
      "buildingType": "RESIDENTIAL",
      "connectionType": "Metered",
      "calculationAttribute": "Water consumption",
      "minimumCharge": 100,
      
      "slabs": [
        {
          "from": 0,
          "to": 10,
          "charge": 2,
          "meterCharge": 50
        },
        {
          "from": 10,
          "to": 20,
          "charge": 2.5,
          "meterCharge": 50
        },
        {
          "from": 20,
          "to": 30,
          "charge": 8,
          "meterCharge": 150
        },
        {
          "from": 30,
          "to": 40,
          "charge": 12,
          "meterCharge": 150
        },
        {
          "from": 40,
          "to": 1000000000,
          "charge": 15,
          "meterCharge": 150
        }
      ]
    },
    {
      "id": "5",
      "buildingType": "RESIDENTIAL",
      "calculationAttribute": "No. of taps",
      "connectionType": "Non Metered",
      
      "minimumCharge": 100,
      "slabs": [
        {
          "from": 0,
          "to": 1000000000,
          "charge": 100
        }
      ]
    },

Estimation

For the disconnection application fee, the estimation will return all the related tax heads based on the criteria.

Following are the exemptions and taxes that are calculated:

• Form fee

• Scrutiny fee

• Meter charge (For metered connection)

• Other charges

• Security charges

• Tax and cess

Water Disconnection Charge & Tax

The water charge is based on the billing slab, and for water disconnection application charge will be based on the slab and tax based on the master configuration.

Interest

Below is a sample of the master data JSON for interest:

{
  "tenantId": "pb",
  "moduleName": "ws-services-calculation",
  "Interest": [
    {
      "rate": 5,
      "minAmount": null,
      "applicableAfterDays":0,
      "flatAmount": null,
      "maxAmount": null,
      "fromFY": "2019-20",
      "startingDay": "1/01/2019"
    }
  ]
}

Penalty

Below is a sample of the master data JSON for penalty -

{
  "tenantId": "pb",
  "moduleName": "ws-services-calculation",
  "Penalty": [
    {
      "rate": 10,
      "minAmount": null,
      "applicableAfterDays": 0,
      "flatAmount": null,
      "fromFY": "2019-20",
      "startingDay": "1/01/2019"
    }
  ]
}

Round Off

If the fraction is greater than equal to 0.5 the number is rounded up else it’s rounded down. eg: 100.4 will be rounded to 100 while 100.6 will be rounded to 101.

Demand Generation

Whenever _calculate API is called demand is first searched based on the connection no and the demand from and to period. If demand already exists the same demand is updated else new demand is generated with consumer code as connection no and demand from and to a period equal to the financial year start and end period.

In case of the update, if the tax head estimates change, the difference in amount for that tax head is added as new demand detail. For example, if the initial demand has one demand detail with WATER_CHARGE equal to 120.

"demandDetails": [
                {
                    "id": "77ba1e93-a535-409c-b9d1-a312c409bd45",
                    "demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
                    "taxHeadMasterCode": "WATER_CHARGE",
                    "taxAmount": 120,
                    "collectionAmount": 120,
                    "additionalDetails": null,
                    "auditDetails": {
                        "createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "createdTime": 1583675275873,
                        "lastModifiedTime": 1583675298705
                    },
                    "tenantId": "pb.amritsar"
                }
            ],

After updating if the WATER_CHARGE increases to 150 we add one more demand detail to account for the increased amount. The demand detail will be updated to:

"demandDetails": [
                {
                    "id": "77ba1e93-a535-409c-b9d1-a312c409bd45",
                    "demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
                    "taxHeadMasterCode": "WATER_CHARGE",
                    "taxAmount": 120,
                    "collectionAmount": 0,
                    "additionalDetails": null,
                    "auditDetails": {
                        "createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "createdTime": 1583675275873,
                        "lastModifiedTime": 1583675298705
                    },
                    "tenantId": "pb.amritsar"
                },
                {
                    "id": "0d83f4b0-6442-11ea-bc55-0242ac130003 ",
                    "demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
                    "taxHeadMasterCode": "WATER_CHARGE",
                    "taxAmount": 30,
                    "collectionAmount": 0,
                    "additionalDetails": null,
                    "auditDetails": {
                        "createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
                        "createdTime": 1583675275873,
                        "lastModifiedTime": 1583675298705
                    },
                    "tenantId": "pb.amritsar"
                }
            ],

The disconnection charges will be the addition of both demand details taxAmount and we can generate demand until the workflow is in PENDING_FOR_DISCONNECTION_EXECUTION.

Here the disconnection charges will be 120+30 = 150

RoundOff is bill based i.e every time bill is generated round off is adjusted so that the payable amount is the whole number. Individual WS_ROUNDOFF in demand detail can be greater than 0.5 but the sum of all WS_ROUNDOFF will always be less than 0.5.

Final water charges calculation

Final Water Charges = Last Billing Period Amount * Days (Proposed disconnection date - Last Billing Date) / No. of days in last billing period

The additional parameter is being sent in the calculation request for the disconnection application.

disconnectRequest = true if the request is for _calculate API disconnection application.

API List

(Note: All the APIs are in the same postman collection therefore the same link is added in each row)

Objective: To provide user facilities to disconnect an active W&S connection when they are not using the service. So, that they don’t have to pay for any charges

Validations

• To disconnect, connection should be in ACTIVE state. Connections which are under WORKFLOW or INACTIVE are not eligible for disconnection.

• In cases dues are pending, user has to clear the dues before applying for Disconnection.

• ‘Disconnect’ option itself is not displayed in the action list for the connection which are INACTIVE.

Route

My Connections → View Connection Details → Disconnect

Clicking on Disconnect it navigates to the Water and Sewerage Disconnection Application Document required screen.

File Path:

File Path:

Date Validation

On Clicking on Next button in the document required screen,

if the proposed date is after <slaDays for disconnection> it will route to Application form Water & Sewerage Disconnection, else it will throw an error in the form of toast messgae, “Date should be after <slaDays for disconnection> from application create Date“.

To get the SLA days /egov-workflow-v2/egov-wf/businessservice/_search?businessServices=DisconnectWSConnection API call is made on load of Application Form Page

Technical Implementation Details:

Initial MDMS call is being made on page load

Mdms data :

On Clicking on Next button in the Application Form Screen , it will route to Upload Documents Screen

On Clicking on Next button in the Upload Documents Screen , it will route to Summary Check Page Screen

In Check Page you can edit the entered data for Disconnection.

On Clicking on Submit button in the Check Page Screen , it will make water or sewerage create and update API calls.

Data fetch , load and render :

• ws-services/wc/_create

Payload: WaterConnection: {

...data,

isdisconnection : true,

isDisconnectionTemporary: true (if Temporary Disconnection selected else false),

disconnectionReason: ““

},

disconnectRequest: true

• sw-services/swc/_create

Payload: WaterConnection: {

...data,

isdisconnection : true,

isDisconnectionTemporary: true (if Temporary Disconnection selected else false),

disconnectionReason: ““

},

disconnectRequest: true

• ws-services/wc/_update

Payload: WaterConnection: {

...data,

isdisconnection : true,

isDisconnectionTemporary: true (if Temporary Disconnection selected else false),

disconnectionReason: ““

},

disconnectRequest: true

• sw-services/swc/_update

Payload: WaterConnection: {

...data,

applicationType: if(Water Application) "DISCONNECT_WATER_CONNECTION" else (if Sewerage Application) "DISCONNECT_SEWERAGE_CONNECTION",

processInstance: {

...data?.processInstance,

businessService: if(Water Application) "DisconnectWSConnection" else (if Sewerage Application) "DisconnectSWConnection",

action: "SUBMIT_APPLICATION", }

},

After the Success of the Create and Update calls it routes users to the Disconnection Acknowledgement screen.

Clicking on the Download Acknowledgement Form button downloads the Water or Sewerage Disconnection Acknowledgement PDF.

Objective: Provide the UI technical implementation details for the My Connections feature available for citizen users.

Workflow Details

Users can review the list of connections and their status registered under their mobile number in the My Connections tab. Each connection in the initial view will display the Consumer No, Service Name, Consumer Name, status, and property Address with the View Details option, through which the User can look up more details about the connection.

Once the user clicks on the View Details button, the Connection Details page is displayed with all the necessary information about the connection.

The link provided in the connection details page is similar to the link provided in the applications details page, eg Consumption details, for more reference

Technical Implementation Details

The path for the My Connections and Connection Details common Index is given below. It provides an understanding of the working of the code.

File path - packages/modules/ws/src/pages/citizen/MyConnection/index.js

The template for My Connection is present within packages/modules/ws/src/pages/citizen/MyConnection/WSConnection.js. The Connection Details page is available within packages/modules/ws/src/pages/citizen/MyConnection/ConnectionDetails.js. The Connection list is retrieved by calling the search API "/ws-services/wc/_search" & "/sw-services/swc/_search" using the searchType as CONNECTION for the filter params.

Hooks used for fetching the connections for Water and Sewerage are:

let filter1 = !isNaN(parseInt(filter))
    ? { tenantId: tenantId, mobileNumber: user?.info?.mobileNumber, searchType:"CONNECTION" }
    : { tenantId: tenantId, mobileNumber: user?.info?.mobileNumber, searchType:"CONNECTION" };

const { isLoading, isError, error, data } = Digit.Hooks.ws.useMyApplicationSearch({ filters: filter1 }, { filters: filter1 });

const { isLoading: isSWLoading, isError : isSWError, error : SWerror, data: SWdata } = Digit.Hooks.ws.useMyApplicationSearch({ filters: filter1,BusinessService:"SW"}, { filters: filter1 });

The code to the linked page, Consumption Details is available in the file: packages/modules/ws/src/pages/citizen/MyConnection/ConsumptionDetails.js

MDMS Data

No MDMS data is used here. All data is loaded from the Search API.

Localization

For My Applications, the localization keys are added in the ‘rainmaker-ws’ locale module same as My connections and create. Changes, updates or addition of any new localization key is done in the same locale module only.

API Role Action Mapping

Overview

After connection activation or legacy connection, the user can choose to disconnect the connection either temporarily or permanently. This process is based on a defined workflow. Any action is based on defined roles on the action level.

Configuration Details

For disconnecting the connection, the user needs to send extra parameters as below :

1. disconnectionReason - to add the reason for disconnection

2. isDisconnectionTemporary - Whether the disconnection is temporary or permanent (if the disconnection is temporary then isDisconnectionTemporary will be true else false)

3. disconnectRequest - This will always be true for disconnection applications.

4. disconnectionExecutionDate - This is the date when the application is disconnected.

and also user needs to upload some supporting documents and mandatory info.

URLs for the external API references

• eGov mdms: egov.mdms.host = /

• eGov -idGen: egov.idgen.host = /

• localization service: egov.localization.host = /

• idGen Id formats : egov.idgen.wdcid.name=waterservice.disconnection.id egov.idgen.wdcid.format=WS_AP/[CITY.CODE]/[fy:yyyy-yy]/DC-[SEQ_WS_APP_[TENANT_ID]]

{
      "format": "WS_AP/[CITY.CODE]/[fy:yyyy-yy]/DC-[SEQ_WS_APP_[TENANT_ID]]",
      "idname": "waterservice.disconnection.id"
}

Persister configuration

Some changes are required in the existing persister files which can be referred to from the following links:

Workflow config for edit connection

Create businessService (workflow configuration) using the /businessservice/_create. Following is the product configuration for editing the water connection.

curl --location --request POST 'https://dev.digit.org/egov-workflow-v2/egov-wf/businessservice/_create' \
--header 'Content-Type: application/json' \
--data-raw '{
	"RequestInfo": {
		"apiId": "Rainmaker",
		"action": "",
		"did": 1,
		"key": "",
		"msgId": "20170310130900|en_IN",
		"requesterId": "",
		"ts": 1513579888683,
		"ver": ".01",
		"authToken": "{{Auth_Token}}"
	},
	"BusinessServices": [
		{
			"tenantId": "pb",
			"businessService": "DisconnectWSConnection",
			"business": "ws-services",
			"businessServiceSla": 259200000,
			"states": [
				{
					"sla": null,
					"state": null,
					"applicationStatus": null,
					"docUploadRequired": false,
					"isStartState": true,
					"isTerminateState": false,
					"isStateUpdatable": true,
					"actions": [
						{
							"action": "INITIATE",
							"nextState": "INITIATED",
							"roles": [
								"CITIZEN",
								"WS_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",
								"WS_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": [
								"WS_DOC_VERIFIER"
							]
						},
						{
							"action": "SEND_BACK",
							"nextState": "PENDING_FOR_COUNTER_EMPLOYEE_ACTION",
							"roles": [
								"WS_DOC_VERIFIER"
							]
						},
						{
							"action": "SEND_BACK_TO_CITIZEN",
							"nextState": "PENDING_FOR_CITIZEN_ACTION",
							"roles": [
								"WS_DOC_VERIFIER"
							]
						}
					]
				},
				{
					"sla": null,
					"state": "PENDING_FOR_FIELD_INSPECTION",
					"applicationStatus": "PENDING_FOR_FIELD_INSPECTION",
					"docUploadRequired": false,
					"isStartState": false,
					"isTerminateState": false,
					"isStateUpdatable": true,
					"actions": [
						{
							"action": "VERIFY_AND_FORWARD",
							"nextState": "PENDING_APPROVAL_FOR_DISCONNECTION",
							"roles": [
								"WS_FIELD_INSPECTOR"
							]
						},
						{
							"action": "SEND_BACK_FOR_DOCUMENT_VERIFICATION",
							"nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
							"roles": [
								"WS_FIELD_INSPECTOR"
							]
						},
						{
							"action": "SEND_BACK_TO_CITIZEN",
							"nextState": "PENDING_FOR_CITIZEN_ACTION",
							"roles": [
								"WS_FIELD_INSPECTOR"
							]
						},
						{
							"action": "REJECT",
							"nextState": "REJECTED",
							"roles": [
								"WS_FIELD_INSPECTOR"
							]
						}
					]
				},
				{
					"sla": null,
					"state": "PENDING_APPROVAL_FOR_DISCONNECTION",
					"applicationStatus": "PENDING_APPROVAL_FOR_DISCONNECTION",
					"docUploadRequired": false,
					"isStartState": false,
					"isTerminateState": false,
					"isStateUpdatable": false,
					"actions": [
						{
							"action": "SEND_BACK_FOR_FIELD_INSPECTION",
							"nextState": "PENDING_FOR_FIELD_INSPECTION",
							"roles": [
								"WS_APPROVER"
							]
						},
						{
							"action": "SEND_BACK_TO_CITIZEN",
							"nextState": "PENDING_FOR_CITIZEN_ACTION",
							"roles": [
								"WS_APPROVER"
							]
						},
						{
							"action": "APPROVE_FOR_DISCONNECTION",
							"nextState": "PENDING_FOR_PAYMENT",
							"roles": [
								"WS_APPROVER"
							]
						},
						{
							"action": "REJECT",
							"nextState": "REJECTED",
							"roles": [
								"WS_APPROVER"
							]
						}
					]
				},
				{
					"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",
								"WS_CEMP"
							]
						}
					]
				},
				{
					"sla": null,
					"state": "PENDING_FOR_COUNTER_EMPLOYEE_ACTION",
					"applicationStatus": "PENDING_FOR_COUNTER_EMPLOYEE_ACTION",
					"docUploadRequired": false,
					"isStartState": true,
					"isTerminateState": false,
					"isStateUpdatable": true,
					"actions": [
						{
							"action": "RESUBMIT_APPLICATION",
							"nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
							"roles": [
								"CITIZEN",
								"WS_CEMP"
							]
						}
					]
				},
				{
					"sla": null,
					"state": "REJECTED",
					"applicationStatus": "REJECTED",
					"docUploadRequired": false,
					"isStartState": false,
					"isTerminateState": true,
					"isStateUpdatable": false,
					"actions": null
				},
				{
					"sla": null,
					"state": "PENDING_FOR_PAYMENT",
					"applicationStatus": "PENDING_FOR_PAYMENT",
					"docUploadRequired": false,
					"isStartState": false,
					"isTerminateState": false,
					"isStateUpdatable": false,
					"actions": [
						{
							"action": "PAY",
							"nextState": "PENDING_FOR_DISCONNECTION_EXECUTION",
							"roles": [
								"CITIZEN",
								"WS_CEMP"
							]
						}
					]
				},
				{
					"sla": null,
					"state": "PENDING_FOR_DISCONNECTION_EXECUTION",
					"applicationStatus": "PENDING_FOR_DISCONNECTION_EXECUTION",
					"docUploadRequired": false,
					"isStartState": false,
					"isTerminateState": false,
					"isStateUpdatable": true,
					"actions": [
						{
							"action": "EXECUTE_DISCONNECTION",
							"nextState": "DISCONNECTION_EXECUTED",
							"roles": [
								"WS_CLERK"
							]
						}
					]
				},
				{
					"sla": null,
					"state": "DISCONNECTION_EXECUTED",
					"applicationStatus": "DISCONNECTION_EXECUTED",
					"docUploadRequired": false,
					"isStartState": false,
					"isTerminateState": true,
					"isStateUpdatable": false,
					"actions": null
				}
			]
		}
	]
}'

Notifications

Disconnection notifications will be sent to the property owners and connection holders based on different application states.

Capturing Connection Holders

We can add connection holders to the water connection which will be the owner of the connection. We can fill in the connection holders' details or we can just make the property owner as the connection holder. It goes the same for disconnection applications.

The connection holder will get a notification based on a different state of the application. We are pushing the data of the connection holders in the user service too.

Integration Steps

1. To integrate, the host of ws-service module should be overwritten in the helm chart.

2. /ws-services/wc/_create should be added as the create endpoint for creating water application/connection in the system

3. /ws-services/wc/_search should be added as the search endpoint. This method handles all requests to search existing records depending on different search criteria

4. /ws-services/wc/_update should be added as the update endpoint. This method is used to update fields in existing records or to update the status of applications based on workflow.

Reference Docs

API List

(Note: All the APIs are in the same postman collection therefore the same link is added in each row)

Introduction

Sewerage Charges are recurring charges levied for a pre-defined billing period. The billing period is configurable as per the state or ULB requirement. The rate for calculation of sewerage charges can vary widely and is dependent upon various parameters. For instance, they can be dependent either upon plot size slab combined with property usage type or solely dependent upon property usage type. In some cases, sewerage charges can also be levied as a percentage of water charges.

Data Table

The data given in the table is sample data for reference.

Procedure

Data Definition

Steps to fill data

1. Download the data template attached to this page.

2. Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.

3. Please reach out to the person who has shared this template with you to discuss and clear your doubts.

4. Select the relevant Property Usage Type from the available drop-down list.

5. Enter the From and To value for property size to specify the range applicable for the selected property.

6. Enter the Flat Fee applicable for the selected property and Slab.

7. Enter the applicable Percentage of Water Charges value. The sewerage charges will be calculated as a percentage of the water charges.

8. Enter the corresponding consumption Rate per unit.

9. Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.

Checklist

The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.

Common Checklist

This checklist covers all the activities which are common across the entities.

Entity Specific Checklist

Separate Entity Specific Checklist is not required for this module data.

Attachments