1 of 24

Water & Sewerage (W&S)

App to facilitate application for new W&S connections, pay bills, activate connections, generate bills

About Water & Sewerage

The Water & Sewerage 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 (W&S) module enables automated processing of new connection requests, generating water bills, and facilitating online payment of bills.

Key Features

DIGIT W&S module enables citizens to -

Apply for new sewerage or water connections
Upload documents required for processing new connections
Pay water or sewerage connection charges and bills using an online payment gateway
Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation
Download water or sewerage connection approval letter, payment receipts, and bills online

DIGIT W&S module enables employees at ULB and State level to -

Process applications using customizable workflows
Configure water and sewerage charges, interest, and penalty calculation logic
View custom dashboards for module statistics
Filter search results using advanced configurable search parameters

Section Overview

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

Functional Specifications
W&S Roadmap
W&S User Manual
Product Brochure
W&S Workflows
Master Data Configuration Template
W&S Service Configuration
Implementation Handbook
Demo Script

Navigation Tips

Click on the embedded links within the content to browse topic details
Use the Contents links available on the right side of the screen to move to a specific heading
Find the list of Related Docs links at the bottom of each page to browse through additional product details

Contact Us

Reach out to us through any of the below-mentioned contact channels for any assistance or additional information on W&S module deployment.

#147/J, 1st floor, 10th Cross, 12th Main, 3rd Block, Koramangala, Bangalore 560034

Find us on map
+91 80 4125 5708
contact@digit.org

W&S Brochure

The DIGIT W&S module facilitates citizens to apply for water and sewerage connections online and pay their bills too. The module supports municipal bodies with automated processing of citizen applications, bill generation and overall management of water and sewerage connections.

W&S Module Functional Specifications

Functional overview for stakeholders

Introduction

The Water and Sewerage (W&S) 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:

Registration, Login and Creation of User Profile
Applying for a new Water/Sewerage connection
Searching for a Connection
Modifications to a Connection
Entering meter reading of metered connections
Generate Demand
Payment collection and Receipts
Closure of water connection
Dashboards and Reports

This module provides enables the following capabilities

OTP Based Login for Citizen via Web/Mobile App
OTP Based Login for Employee via Web/Mobile App
Provision for language selection during first time registration for both Employee and citizens
Provision of creating a personalized Profile for Citizens and employees on Web App
Login Credentials for the various hierarchy of employees
Role-based access for performing different actions relating to the W&S module

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 W&S 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, 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 Owners mobile number, Property ID, Consumer number etc. The search result yields, Owner’s Name, Address, Due amount and Pay option.

Modifications to a Connection

The system facilitates the title transfer of 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 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 intimate all stakeholders of the change and collect any charges (if applicable) from the citizen.

Entering meter reading of metered connections

On the W&S 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 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 got his 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 would not be generated for the connection. Application for the closing of 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 W&S can be accessed by a state-level user under login. The dashboard has these components:

Financial Indicators
- W&S 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.

W&S Implementation Guide

Section 1: Executive Summary

Overview of the Product

Access to clean and safe water is one of the basic needs of citizens. Each Urban local body has been mandated with catering to the water and sanitation needs of its citizens. The computerized and automatic Water and Sewerage system offered by eGov enables citizens who seek to apply and pay for water and sewerage connections within any Urban Local Body with a transparent, speedy, hassle-free and user-friendly procedure. The ULB officials can now sanction connections, generate bills and collect payments for water and sewerage connections more efficiently. (For details on product features refer to Section 2)

Implementation Methodology for W&S

For the offered product, the implementation process can be divided into six major distinctive stages. Each stage has predefined entry and exit criteria, roles & responsibilities to assure objective monitoring and decision-making for the overall success of the engagement. The whole implementation lifecycle is typical of 23-27 weeks for the State/UT keeping in mind the entry, and exit criteria defined at the beginning and end of each stage are met on time recommended.

Stage Zero-program setup and onboarding is a pre-requisite for the initiative to kick off and requires setup of the governance model, implementation team and decision regarding other significant elements of the initiative like funding and procurement process. Stage One of the initiative requires scoping the initiative and deciding on the priorities for implementation by the State/UT Implementation Team. In Stage Two, the W&S team is appointed and its processes are standardized. In Stage Three, the State/UT Team will work on identifying and finding solutions to the significant gaps in the product offered w.r.t. to the need of the State/UT. Configuration and customization of the product is the primary objective of Stage Four. This involves working on various aspects of UT-specific needs and incorporating them into the product suite offered. In Stage Four and Five, post doing UAT and including all the necessary feedback on the product, the roll-out of the product is done at the State/UT level(Go Live) from a couple of ULBs to pan State/UT coverage. In Stage Six of sustenance and ongoing improvement, key activities are adoption and governance tracking with the planning of ongoing sustenance. (For details on the implementation plan refer to Section 3).

Critical Success Factors For Implementation

Implementation of Water and Sewerage (W&S) requires meticulous planning and close coordination between various stakeholders at the centre and State/UT levels. The success of the initiative is dependent upon many factors like strong Program governance, availability of trained resources, financial planning, targeted implementation Team onboarding, focus on last-mile capacity building and ensuring necessary support to the urban centre. Achievement of all these factors will provide the most effective and efficient roll-out and adoption of the Water and Sewerage Implementation System in the UT.

Section 2: Water and Sewerage (W&S) Product - Overview

The Water and Sewerage (W&S) module provides a digital interface to apply for water and sewerage connections and pay the water and sewerage charges for connection/s. The citizens can use it, 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. The W&S product features can be broadly classified as the following modules:

Registration, Login and Creation of User Profile
Application for new Water/Sewerage connection
Searching for a Connection
Modifications to a Connection
Entering meter readings of metered connections
Generate Demand
Payments collection and Receipts
Dashboards and Reports

This module provides enables the following capabilities:

OTP-based login for citizens via Web/Mobile App
OTP-based login for employees via Web/Mobile App
Provision for language selection during first-time registration for both employees and
citizens
Provision of creating a personalized profile for citizens and employees on the Web App
Login credentials for the various hierarchy of employees
Role-based access for performing different actions relating to the W&S module

Module 2: Application for new Water & Sewerage connection

Module 3: Searching for a Connection

Only employees from the W&S 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 the 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 connections in the portal. They can search using the Owners mobile number, Property ID, Consumer number etc. The search result yields, the Owner’s Name, Address, Due amount and Pay options.

Module 4: 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.

Module 5: Entering meter reading of metered connections

On the W&S 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.

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.

Module 6: 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.

Module 7: Payments collection and Receipts

Module 8: Closure of Water Connection

If the Water tap owner has got his 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 would 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.

Module 9: Dashboards and Reports

The state-level administrator can keep track of relevant metrics by using dashboards. Dashboards for W&S can be accessed by a state-level user under login.

The dashboard has these components:

Financial Indicators
- W&S 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

Section 3 Water and Sewerage (W&S) Implementation Methodology

This section provides an overview of the methodology for the State-wide implementation of W&S. The Implementation of W&S is distributed across seven distinct stages. Each stage has predefined entry & exit criteria and roles & responsibilities. This is to ensure objective monitoring and decision-making for the overall success of the program. Details of each stage are defined in this section.

Note: This document is specific for States that have more than 30 ULBs.

W&S implementation program is expected to be completed approximately between 38- 42 weeks with the resource deployment by the State and System Integrator (SI) Team (as defined below). However, it is critical that activities and exit criteria set for each stage are achieved to adhere to this timeline.

Seven Stages of Implementation

Stage 0 - Program Setup/Onboarding

There is a set of initial critical activities that are undertaken upon receiving a letter of enrollment from the State/Union Territory. Successful completion of these activities assures that the program is started with crucial personnel, System Integrator(SI) teams and funds.

Vision

Define the value proposition of the programme for the state
Define the time frame within which the state needs to:
- Go live
- Scale pan-state
Define Year-on-Year(YoY) Financial Targets

System Integrator(SI) Sign-up:

System Integrator and state will agree on program scope, program timelines, and budgeting & resourcing.

Stage 1 - Program Kick-Off

This stage envisages the in-person interaction of crucial State/UT officials and implementation System Integrator(SI) Teams to kick-start the program. This stage may require multiple interactions/meetings with different stakeholders. The principal objective of these interactions is to identify scope, plan strategies for phasing/rollout (in pilot ULBs/Pan State) and create an active collaboration & Governance approach and agree on a high-level timeline for the engagement.

Note

1) State Baseline Data (As per the Module): A Baseline Template is provided to collect certain vital information like no. of transactions, revenue collected in the last FYs, collection mode, budget data, etc. This data is vital for various analyses at the state level. This data must be collected pre-rollout. The baseline data collection templates will be provided to the state/SI Team.

2) ULBs Specific Product Data Configuration: This Master data is required from the Product Perspective to go live. For eg: Connection Legacy Data, Boundary Data, List of Employees, Rates etc. Master Data Template will be provided for the collection of this particular data type.

Stage 2 - Solution Design

During the Solution design stage, key State/UT officials and members, who are subject matter experts, are expected to share State/UT acts and policies and help interpret the same for the System Integrator (SI) Team. This stage baselines the State/UT-specific product features in the Product Configuration report.

Stage 3 - Configuration & Customization

This stage consists of a series of developments in accordance with the detailed project plan to ensure the smooth functioning of the customised product. Preparation for the testing and data collection of the product UAT is complete. Further monitoring and maintenance strategies are put in place.

Stage 4 - UAT & Go Live

During this stage, a demonstration of the product followed by a hand on session is conducted for the ULB officials. Necessary training of ULB officials and resources required for UAT is conducted and identified respectively. The establishment of the State/UT support Team and required processes are initiated in this stage.

Stage 5 – Rollout

On successful Go-Live in the Pilot ULBs, after further configurations to stabilize the product, the solution will be rolled out to the rest of the ULBs in multiple phases. Guidance and support from the State/UT Team will be required to create the rollout plans and assure the necessary infrastructure for training and deployment is available at each ULB.

Note: The rollout phase needs to be detailed out for iterative activities of onboarding ULBs in batches.

Note: Only once all the stages are complete in one batch of the rollout of around 30 ULBs, the next batch begins. There are multiple phases of rollout. The second batch begins after the first batch has successfully fulfilled all the criteria of the Rollout Phase. Typical timelines for closure of rollout in each batch is 5-6 weeks (in a batch of 30 ULBs).

Stage 6 – Sustenance and Ongoing Improvement

The final stage consists of strategies to ensure the sustenance of the product in the State/UT. Systems are put in place to ensure the continuous tracking of data and provisions are made to improve the product if new data suggest.

Section 4: Roles and Responsibilities – W&S Cell, NUS Team & System Integrator (SI)Team

This section outlines the activities involved in each stage of the implementation along with the responsibility and accountability of critical stakeholders - UT, NUS Team and System Integrator Team onboard.

W&S Cell: W&S Cell is the government-appointed body chaired by the Principal Secretary/Secretary, Urban Development Department with members from Urban Development Department etc.

Resource requirements for the W&S cell required to be formed by the UT

Note: The designation mentioned above is as per designations known to drive W&S implementation at the State/UT level (explained below). These are the preferred figures in the case of Domain Expert, 2 people are subject to availability.

Project Head: Is the Head of the W&S Cell who will drive the project from the State/UT Side
Domain Expert: A person who is well aware of the on-ground scenario, well versed with the act, GOs passed, Prevalent Business processes, Deviations from the acts, Rates/ slabs applicable
Nodal officer (EO/Commissioner/ Senior Official): the product coordinator to drive the project centrally; monitors usage post Go Live; point of escalation for Implementation Team; seasoned and worked in multiple ULBs on various modules and has a good understanding of W&S; facilitates and tracks data collection post-go-live; monitors and facilitates the adoption of the application; point of contact for eGov, SI and at the HQ level.
MIS Expert: Day-to-day tracking of the program, data entry, reporting and review to senior officials

eGov Team: eGov Team is the technical partner of the project which will provide all necessary support to the State/UT concerning the implementation, Program Designing etc.

System Integrator (SI) Team: SI Team will be responsible for the rollout of the initiative in the UT, providing end-to-end support to the State/UT w.r.t. The implementation of the products in the ULBs.

Guidelines to read the table are mentioned on the next page:

Execute - One who owns the accountability to complete the activity
Consult - One who may initiate, guide and in the process, handhold the execution of the activity

Note: Stage 0 is where the W&S cell and SI team are formed, hence there are only two entities playing a role which are that of eGov and the state leadership. Once the W&S cell and SI team are finalized, their role begins in the following stages.

Section 5: Overall Program Assumptions

Glossary

Vision: Defining the time frame to go live, the time frame to scale it pan state, the value proposition of the programme for the state and year-on-year financial targets and adoption targets

Project Plan: A detailed plan of program schedule/timelines, implementation phases, team structure and ongoing support and maintenance required.

System Integrator: The entity/company which collates all the subsystems required for the project and integrates them to achieve the program objective

Program Charter: Outline of implementation plan agreement with priority applications and broad timelines, program governance model, program success metrics and capacity building.

Acceptance Letter/MOU: Formal acceptance/sign-off of the client state with a clear mandate of the program

Program Success Metrics: Defining the parameters (which are measurable) prior to the program, on which the success of the program is to be measured on the completion of the program

Project steering committee: The key body within the governance structure which is responsible for the business issues associated with the project that are essential in ensuring the delivery of the project outputs and the attainment of project outcomes.

Project governance: Set of policies, regulations, functions, processes, procedures and responsibilities that define the establishment, management and control of projects, programmes and portfolios.

Scoping: List of activities measured against the time taken to complete them in accordance with the project goals

Baseline data: Set of information that serves as a foundation to compare other data acquired afterwards

Project Kick-off meeting: Meeting with the project team and the client of the project. This meeting would follow the definition of the base elements for the project and other project planning activities

Fitment Study: GAP study of the existing/required field process vs product

Data migration: Existing records of the functional activities need to be moved into the database of the newly released application

Data collection: Required data for the roll-out of the applications, which needs to be collected from the existing functional process

Data validation approach: This approach enables the sanctity of the data with built-in validation by design

Data synchronization: The process of establishing consistency among data from a source to a target data storage and vice versa and the continuous harmonization of the data over time.

Pilot Implementation: Any new process is tested out as a pilot in one or two instances before pan implementation.

Pilot ULB: The ULBs selected for the pilot implementation are called pilot ULB.

Roll out: On successful clearance of the pilot, the process/application/services are implemented across all Offices/ULBs.

Deployment: Deployment defines the complete package of software components set up in a particular environment.

Customisation: Details of changes to be made in the product to comply with the needed field process.

Configuration: Defining existing content such as options and variables based on the requirements on the ground

Product walkthrough: Explaining the users step-by-step through a set of actions that they need to take to achieve a specific outcome.

Legacy/Re-Indexing the Water & Sewerage Service

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"
      }
    }
  ]
}

State DSS - Water & Sewerage

Technical Doc

Overview

DSS has two sides to it. One is the process in which the data is pooled into ElasticSearch and the other is the way it is fetched, aggregated, computed, transformed and sent across.

As this revolves around a variety of data sets, there is a need for making this configurable. So that, tomorrow, given a new scenario is introduced, then it is just a configuration away from getting the newly introduced scenario involved in this process flow.

This document explains the steps on how to define the configurations for the analytics side of DSS for W&S.

What is analytics?

Analytics: Micro Service which is responsible for building, fetching, aggregating and computing the data on ElasticSearch to a consumable data response. This is later used for visualizations and graphical representations.

Analytics Configurations: Analytics contains multiple configurations. We need to add the changes related to Water & Sewerage(W&S) in this dashboard analytics. Here is the location: Below is a list of configurations that need to be changed to run W&S successfully.

Chart API Configuration
Master Dashboard Configuration
Role Dashboard Mappings Configuration

Configuration Details

Chart API Configuration

Each visualization has its own properties. Each visualization comes from different data sources (Sometimes it is a combination of different data sources). In order to configure each visualization and its properties, we have a chart API configuration document.

In this, visualization code, which happens to be the key, will be having its properties configured as a part of the configuration and are easily changeable.

Here is the sample ChartApiConfiguration.json data for the W&S.

Master Dashboard Configuration

Master dashboard configuration is the main configuration which defines the dashboards to be painted on the screen.

It includes all the visualizations, their groups, the charts which come within them and even their dimensions as what should be their height and width.

Role Dashboard Mappings Configuration

Master Dashboard Configuration which was explained earlier contains the list of dashboards which are available. Given the instance where Role Action Mapping is not maintained in the Application Service, this configuration will act as Role - Dashboard Mapping Configuration.

In this, each role is mapped against the Dashboard which they are authorised to see. This was used earlier when the Role Action Mapping of eGov was not integrated.

Later, when the Role Action Mapping started controlling the dashboards to be seen on the client side, this configuration was just used to enable the dashboards for viewing.

MDMS Configuration

common-masters/uiCommonConstants.json

roleaction.json

Action test.json

Charts Overview

W&S-DSS consists of multiple graphs which represent the data of W&S. Each graph has its own configuration which will describe the chart and its type.

DSS consists of the following charts in W&S:

Revenue Tab

Overview
Total Cumulative Collection
Top ULB By Performance
Bottom ULB by Performance
W&S Collection by Usage Type
W&S Collection by Channel Type
W&S Key Financial Indicators
W&S Tax Heads

Service Tab

Overview
Total Cumulative Connection
Water Connection By Usage
Sewerage Connections By Usage
Connection By Channel
W&S Connection Ageing

Revenue Tab

Overview

The overview graph contains multiple data information as below in the selected time period.

Today’s Collection: This represents today’s collection amount for Water and Sewerage Application Fee + Consumption Charges.
Total Collection: This represents the total collection amount for Water and Sewerage Application Fee + Consumption Charges.
Target Collection: This represents the target collection amount for the Water and Sewerage connections.
Target Achievement: This represents the target achieved in percentage. This is calculated by the formula- (Total Collection/Target Collection)*100%

Total Cumulative Collection

This Graph contains the Water and Sewerage collection amount information on a monthly basis as a cumulative line graph for each water and sewerage collection separately. This will change as per the denomination amount filter selection.

line - this graph/chart is data representation on date histograms or date groupings.

Top ULB By Performance

This graph represents the ULBs based on the Target achieved in bar chart representation with the % of target achieved in descending order.

Bottom ULB by Performance

This graph represents the ULBs based on the target achieved in bar chart representation with the % of target achieved in ascending order.

W&S Collection by Usage Type

This graph shows the collection amount based on the usage/property type and this amount will change as per the denomination filter change.

W&S Collection by Channel Type

This graph shows the collection amount based on the collection channel type(eg-online, counter, etc) and this amount will change as per the denomination filter change.

W&S Key Financial Indicators

This tabular chart representation graph shows multiple W&S information like Target Collection, Total Collection, Total Transactions, Total Connections and Target Achievement (in %). And this table shows the data at the district level and also has the drill-down chart for each district to ulb and from ulb to ward level data for the same.

xtable type allows to the addition of multiple computed fields with the aggregated fields dynamically added.

To add multiple computed columns, computedFields [] where actionName (IComputedField<T> interface), fields [] names as in exist in query key, newField as name to appear for computation must be defined.

On click of any district name will enter into drill-down charts, which will represent that specific District data.

On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.

W&S Tax Heads

This tabular chart representation graph shows multiple W&S information like Total Collection, Penalty, Interest and Target Collection. And this table shows the data at the district level and also has the drill-down chart for each district to ulb and from ulb to ward level data for the same.

table type allows to addition of multiple aggregated fields.

On click of any district name will enter into drill-down charts, which will represent that specific District data.

On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.

Service Tab

Overview

The overview graph contains multiple data information as below in the selected time period.

Total Applications: This represents the total number of applications for new, modify, and disconnection requests.
SLA Compliance: This represents the total SLA achieved in percentage.
Total Active Connections: This represents the total active water and sewerage connections.
Water-Metered Connections: This represents the total active metered water connections.
Water-Non Metered Connections: This represents the total active non-metered water connections.
Sewerage Connections: This represents the total active sewerage connections.

Total Cumulative Connections

This Graph contains the Water and Sewerage connections information on a monthly basis as a cumulative line graph for each water and sewerage connection separately.

line - this graph/chart is data representation on date histograms or date groupings.

Water Connections by Usage Type

This graph shows the active Water connections based on the usage/property type.

Sewerage Connections by Usage Type

This graph shows the active Sewerage connections based on the usage/property type.

W&S Connections by Channel Type

This graph shows the active water and sewerage connections by channel type(eg-online, counter, etc).

W&S Connection Ageing

This tabular chart representation graph shows W&S applications that have been submitted and have been pending to be worked on. Information like Pending from 0 to 3 days, Pending from 3 to 7 days, Pending from 7 to 15 days, Pending for more than 15 days, and Total Pending Applications is shown in the chart. And this table shows the data at the district level and also has the drill-down chart for each district to ulb and from ulb to ward level data for the same.

xtable type allows the addition of multiple computed fields with the aggregated fields dynamically added.

On click of any district name will enter into drill-down charts, which will represent that specific District data.

On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.

Newly Introduced Property

isRoundOff: This property is introduced to round off the decimal values. Ex: if the value is 25.43 by using isRoundOff property in the configuration we will get it as 25. if the value is 22.56 round of value will be 23. This can be used for insights configuration as well for overview graphs.

Common Properties Available

Key(eg: fsmTotalrequest): This is the Visualization Code. This key will be referred to in further visualization configurations.

This is the key which will be used by the client application to indicate which visualization is needed for display.

chartName: The name of the Chart which has to be used as a label on the Dashboard. The name of the Chart will be a detailed name.

In this configuration, the Name of the Chart will be the code of Localization which will be used by the Client Side.

queries: Some visualizations are derived from a specific data source. While some others are derived from different data sources and are combined together to get a meaningful representation.

The queries of aggregation which are to be used to fetch the right data in the right aggregated format are configured here.

queries.module: The module/domain level, on which the query should be applied on. Water and sewerage are W&S.

queries.indexName: The name of the index upon which the query has to be executed is configured here.

queries.aggrQuery : The aggregation query in itself is added here. Based on the Module and the Index name specified, this query is attached to the filter part of the complete search request and then executed against that index

queries.requestQueryMap: Client Request would carry certain fields which are to be filtered. The parameters specified in the Client Request are different from the parameters in each of these indexed documents.

In order to map the parameters of the request to the parameters of the ElasticSearch Document, this mapping is maintained.

queries.dateRefField: Each of these modules have separate indexes. And all of them have their own date fields.

When there is a date filter applied against these visualizations, each of them has to apply it against their own date reference fields.

In order to maintain what is the date field in which index, we have this configured in this configuration parameter.

chartType: As there are different types of visualizations, this field defines what is the type of chart/visualization that this data should be used to represent.

Chart types available are:

metric - this represents the aggregated amount/value for records filtered by the aggregate es query

pie - this represents the aggregated data on grouping. This is can be used to represent any line graph, bar graph, pie chart or donut

line - this graph/chart is data representation on date histograms or date groupings

perform - this chart represents groping data as performance-wise.

table - represents a form of plots and values with headers as grouped on and a list of its key, values pairs.

xtable - represents an advanced feature of the table, it has additional capabilities for dynamic adding header values.

valueType: In any case of data, the values which are sent to the plot, might be a percentage, sometimes an amount and sometimes it is just a count.

In order to represent them and differentiate the numbers from the amount from the percentage, this field is used to indicate the type of value that this Visualization will be sending.

action: Some of the visualizations are not just aggregations of data sources. There might be some cases where we have to do a post-aggregation computation.

For Example, in the case of the top 3 Performing ULBs, the Target and Total Collection are obtained and then the percentage is calculated. In these kinds of cases, the action that has to be performed on the data obtained is defined in this parameter.

documentType: The type of document upon which the query has to be executed is defined here.

drillChart: If there is a drill down on the visualization, then the code of the Drill Down Visualization is added here. This will be used by Client Service to manage drill-downs.

aggregationPaths: All the queries will be having Aggregation names in them. In order to fetch the value out of each Aggregation Response, the name of the aggregation in the query will be an easy bet. These aggregation paths will have the names of Aggregation in it.

insights: It is to show the data with the comparison of last year with arrow symbols, it will show the data in how much % is increased or decreased.

_comment: In order to display information on the “i” symbol of each visualization, Visualization Information is maintained in this field.

Water Calculator Service

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

Deploy the latest version of ws-service and ws-calculator
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 :

connection type
building type
calculation attribute
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 WCBillingSlab. 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
        }
      ]
    }

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:

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.

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

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.
For the Metered Connection service, to get the previous meter reading /meterConnection/_search API is used.
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.
To generate the demand for metered or non-metered water connection /waterCalculator/_calculate API is used.
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.
/waterCalculator/_jobscheduler API is use to generate demand for Non-metered connections. This API can be called periodically.
/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)

Sewerage Calculator Service

Overview

Sewerage Calculator Service is one of the major business logic services which is used for calculation of sewerage charge, generating demand, update existing demand, SMS & email notification to the ULB officials on-demand generation and also triggering demands(job scheduler) at some intervals and estimation of sewerage 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 sewerage service persister configs path added in it
PSQL server is running and a database is created to store sewerage connection / application data
Following services should be up and running:
- egov-perister
- egov-mdms
- sw-services
- billing-service

Key Functionalities

Sewerage calculator services present in municipal services provide multiple functionalities like calculating sewerage charges, generating demands for a particular sewerage connection, updating demands, SMS & email notification to the ULB officials on-demand generation and also triggering demands(job scheduler) at some intervals and estimation of sewerage charge(one-time cost) which involves cost like road-cutting charge, form fee, scrutiny fee etc. The different functionalities provided by sewerage calculator services are:

Sewerage charge calculation
Demand generation(here as its always non-metered demand will be generated based on time period)
Sewerage charge estimation (one-time cost which involves cost like road-cutting charge, form fee, scrutiny fee etc.)

Deployment Details

Deploy the latest version of sw-service and sw-calculator
Add sewerage-persist.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 :

connection type
building type
calculation attribute
property usage type

If all criteria will match for that sewerage 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 sw-services-calculation.

All the above master configuration is used for estimation.

Following are the exemptions and taxes that are calculated:

Form fee
Scrutiny fee
Other charges
Road cutting charges
One time fee
Security charges
Tax and cess

Sewerage Charge and Tax

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

Interest

Below is a sample of master data JSON for interest :

Penalty

Below is a sample of master data JSON for penalty**:**

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

Role Action Mapping

Demand Generation

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

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

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 SW_ROUNDOFF in demand detail can be greater than 0.5 but the sum of all SW_ROUNDOFF will always be less than 0.5.

Scheduler for generating the demand

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

If the same job trigger multiple time what will happen?

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.1sw.demand.based.batch.size=10

Integration Details

Integration Scope

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

Integration Benefits

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

Steps to Integration

To Activate the Sewerage Service application, the user needs to pay the ONE_TIME_FEE for the connection. To calculate the ONE_TIME_FEE sw-calculator/sewerageCalculator/_estimate API is use.
To generate the demand for non-metered sewerage connection /sw-calculator/sewerageCalculator/_calculate API is use.
User can pay partial / full / advance amount for the Non-Metered connection bill. In these cases, Billing service would call back /sw-calculator/sewerageCalculator/_updateDemandAPI to update the details of the demand generated.
/sw-calculator/sewerageCalculator/_jobscheduler API is use to generate demand for Non-metered connections. This API can be called periodically.
/sw-calculator/sewerageCalculator/_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)

Sewerage Charges Master Data Templates

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 -

Apply for new sewerage connections.
Upload documents required for processing new connections.
Pay sewerage connection charges and bills using online payment gateway.
Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation.
Download sewerage connection approval letter, payment receipts, and bills online.

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

Process applications using customizable workflows.
Configure sewerage charges, interest, and penalty calculation logic.
View custom dashboards for module statistics.
Filter search results using advanced configurable search parameters.

Module Ontology

State Level

None

ULB Level

Module Reports

None

Sewerage Rates

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

Sr. No.

*Property Usage Type

*Property size slab from (units)

*Property size slab to (units)

*Percentage of water charges (%)

*Flat fee (in Rs)

*Rate

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Select the relevant Property Usage Type from the available drop-down list.
Enter the From and To value for property size to specify the range applicable for the selected property.
Enter the Flat Fee applicable for the selected property and Slab.
Enter the applicable Percentage of Water Charges value. The sewerage charges will be calculated as a percentage of the water charges.
Enter the corresponding consumption Rate per unit.
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

Sewerage Penalty Rates

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 -

Fixed amount; or
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

Sr. No.

*Penalty based on (Bill amount/Balance pending)

*Grace period (days)

Penalty flat amount (Rs)

Penalty (%)

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Enter the applicable value for the Grace Period.
Enter the corresponding Penalty Flat Amount.
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.
Enter the applicable percentage value for calculating the Penalty amount.
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

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

Sewerage Interest Rates

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 -

Entire bill amount
Balance pending when partial payments have been made

Data Table

Sr. No.

*Interest based on (Bill amount/Balance pending)

*Grace Period (days)

*Interest rate

Data given in the table is sample data for reference.

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Enter the applicable Grace Period for calculating interest.
Select the relevant parameter for Interest-Based On to specify if the interest is applied to the bill amount or pending balance.
Enter the applicable percentage value for Interest Rate that will be used to calculate the interest amount.
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

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

Water Charges Master Data Templates

This page provides configuration details for W&S master data templates

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 -

Apply for new water connections.
Upload documents required for processing new connections.
Pay water connection charges and water bills using an online payment gateway.
Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation.
Download water connection approval letter, payment receipts, and bills online.

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

Process applications using customizable workflows.
Configure water charges, interest, and penalty calculation logic.
View custom dashboards for module statistics.
Filter search results using advanced configurable search parameters.

Module Ontology

State Level

None

ULB Level

Module Reports

None

Water Rates (Metered)

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

Sr. No.

*Property Usage Type

*Water consumed value from (units)

*Water consumed value to (units)

*Rate (in Rs/ unit)

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Select the property type from the drop-down list available in the Property Usage Type column.
Enter the Slab (water consumed) range details in the From and To Value for water consumed.
Enter the Rate for the specified slab range and property type.
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

Pipe Size Types

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

Sr. No.

Pipe Size*

UOM*

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to understand the headers in the template sheet, their data type, size, and definitions.
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.
Enter the Pipe Size details.
Enter the corresponding UOM for the specified Pipe Size.
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

Water Source Types

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

Sr. No.

*Water source

*Water sub source

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document for more details on data type, size, and definitions.
Contact the person who shared this template with you to discuss and clear your doubts.
Enter the relevant Water Source.
Enter the corresponding Water Sub Source. This will map the water sub source to the specified water source.
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

Water Rates (Non-Metered)

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

Sr. No.

Property Usage Type*

Property size value from (units)

Property size value to (units)

No. of taps

Rate

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Select the property type from the drop-down list available in the Property Usage Type column.
Enter the Slab (property size value) range details in the From and To Value for property size.
Enter the value for No. of Taps. The water charges will be calculated on the number of taps.
Enter the Rate or the per-unit water consumption charges that will be applicable for the listed parameters.
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

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

Water Penalty Rates

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 -

Fixed amount
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

Sr. No.

*Penalty based on (Bill amount/Balance pending)

*Grace period (days)

*Penalty flat amount (Rs)

*Penalty (%)

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Enter an appropriate value for Penalty Based On.
Enter a value for the Grace Period.
Enter the Penalty Flat Amount.
Enter the Penalty value in percent.
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

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

Water Interest Rates

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 -

Entire bill amount
Balance pending when partial payments have been made

Data Table

Sr. No.

*Interest based on (Bill amount/Balance pending)

*Grace Period (days)

*Interest rate (%)

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

Procedure

Data Definition

Sr. No.

Column Name

Data Type

Data Size

Mandatory

Description

Steps to fill data

Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Enter the Grace Period.
Select the relevant Interest-based On parameter.
Enter the Interest Rate.
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

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

W&S User Manual

An illustrative guide to using Water & Sewerage module

The W&S 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.

Features and applications

The module supports the following key functions -

Apply for new connections
Pay one-time connection charges for new water or sewerage connections
Pay recurring bills using online payment gateway
Download artefacts such as application details, connection details, bills, receipts, sanction letter and estimation notice
Process applications using configurable workflows

User roles

Refer to the table below to understand the different user roles and the scope of action linked to each role. The applicable user roles and action items can vary from one State to another. DIGIT customizes the workflows to suit the requirements defined at the State level.

User Role

Scope of Action

Role Description

Using W&S

This section guides you through the details of using the [module name] module for each role. Click on the relevant role below to learn more about how to use the module.

State DSS - Water & Sewerage

Technical Doc

Overview

DSS has two sides to it. One is the process in which the data is pooled into ElasticSearch and the other is the way it is fetched, aggregated, computed, transformed and sent across.

This document explains the steps on how to define the configurations for the analytics side of DSS for W&S.

What is analytics?

Chart API Configuration
Master Dashboard Configuration
Role Dashboard Mappings Configuration

Configuration Details

Chart API Configuration

In this, visualization code, which happens to be the key, will be having its properties configured as a part of the configuration and are easily changeable.

Here is the sample ChartApiConfiguration.json data for the W&S.

Master Dashboard Configuration

Master dashboard configuration is the main configuration which defines the dashboards to be painted on the screen.

It includes all the visualizations, their groups, the charts which come within them and even their dimensions as what should be their height and width.

{
      "name": "DSS_W&S_DASHBOARD",
      "id": "ws",
      "isActive": "",
      "style": "linear",
      "visualizations": [
        {
          "row": 1,
          "name": "DSS_REVENUE",
          "vizArray": [
            {
              "id": 211,
              "name": "DSS_STATE_WS_OVERVIEW",
              "dimensions": {
                "height": 350,
                "width": 5
              },
              "vizType": "metric-collection",
              "noUnit": true,
              "isCollapsible": false,
              "label": "DSS_OVERVIEW",
              "charts": [
                {
                  "id": "wstodaysCollection",
                  "name": "DSS_W&S_TODAYS_COLLECTION",
                  "code": "",
                  "chartType": "metric",
                  "filter": {"title": "TODAY"},
                  "headers": []
                },
                {
                  "id": "wstotalCollection",
                  "name": "DSS_W&S_TOTAL_COLLECTION",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                },
                {
                  "id": "wstargetCollection",
                  "name": "DSS_W&S_TARGET_COLLECTION",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                },
                {
                  "id": "wstargetAchieved",
                  "name": "DSS_W&S_TARGET_ACHIEVED",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                }
              ]
            },
            {
              "id": 212,
              "name": "DSS_W&S_TOTAL_CUMULATIVE_COLLECTION",
              "dimensions": {
                "height": 350,
                "width": 7
              },
              "vizType": "chart",
              "noUnit": true,
              "isCollapsible": false,
              "charts": [
                {
                  "id": "wscumulativeCollections",
                  "name": "Monthly",
                  "code": "",
                  "chartType": "line",
                  "filter": "",
                  "headers": []
                }
              ]
            }
          ]
        },
        {
          "row": 2,
          "name": "DSS_REVENUE",
          "vizArray": [
            {
              "id": 221,
              "name": "DSS_W&S_TOP_3_PERFORMING_ULBS",
              "dimensions": {
                "height": 250,
                "width": 4
              },
              "vizType": "performing-metric",
              "noUnit": false,
              "isCollapsible": false,
              "label": "",
              "charts": [
                {
                  "id": "wstopPerformingUlbs",
                  "name": "DSS_W&S_TOP_3_PERFORMING_ULBS",
                  "code": "",
                  "chartType": "bar",
                  "filter": "",
                  "headers": []
                }
              ]
            },
            {
              "id": 222,
              "name": "DSS_W&S_BOTTOM_3_PERFORMING_ULBS",
              "dimensions": {
                "height": 250,
                "width": 4
              },
              "vizType": "performing-metric",
              "noUnit": false,
              "isCollapsible": false,
              "charts": [
                {
                  "id": "wsbottomPerformingUlbs",
                  "name": "DSS_W&S_BOTTOM_3_PERFORMING_ULBS",
                  "code": "",
                  "chartType": "bar",
                  "filter": "",
                  "headers": []
                }
              ]
            }
          ]
        },
        {
          "row": 3,
          "name": "DSS_REVENUE",
          "vizArray": [
            {
              "id": 223,
              "name": "DSS_W&S_COLLECTION_BY_USAGE",
              "dimensions": {
                "height": 250,
                "width": 4
              },
              "vizType": "chart",
              "noUnit": true,
              "isCollapsible": false,
              "charts": [
                {
                  "id": "wscollectionByUsage",
                  "name": "DSS_W&S_COLLECTION_BY_USAGE",
                  "code": "",
                  "chartType": "donut",
                  "filter": "",
                  "headers": []
                }
              ]
            },
            {
              "id": 224,
              "name": "DSS_W&S_COLLECTION_BY_CHANNEL",
              "dimensions": {
                "height": 250,
                "width": 4
              },
              "vizType": "chart",
              "noUnit": true,
              "isCollapsible": false,
              "charts": [
                {
                  "id": "wscollectionByChannel",
                  "name": "DSS_W&S_COLLECTION_BY_CHANNEL",
                  "code": "",
                  "chartType": "donut",
                  "filter": "",
                  "headers": []
                }
              ]
            }
          ]
        },
        {
          "row": 4,
          "name": "DSS_REVENUE",
          "vizArray": [
            {
              "id": 231,
              "name": "DSS_WS_KEY_FY_INDICATORS",
              "dimensions": {
                "height": 350,
                "width": 12
              },
              "vizType": "chart",
              "noUnit": false,
              "isCollapsible": false,
              "charts": [
                {
                  "id": "wsFinancialIndicatorDDR",
                  "name": "DSS_W&S_DEMAND_COLLECTION_BOUNDARY",
                  "code": "",
                  "chartType": "table",
                  "filter": "",
                  "headers": [],
                  "tabName": "Boundary"
                }
              ]
            }
          ]
        },
        {
          "row": 5,
          "name": "DSS_REVENUE",
          "vizArray": [
            {
              "id": 231,
              "name": "DSS_W&S_TAX_HEAD_BOUNDARY",
              "dimensions": {
                "height": 350,
                "width": 12
              },
              "vizType": "chart",
              "label": "",
              "noUnit": false,
              "isCollapsible": true,
              "charts": [
                {
                  "id": "wsTaxHeadDDR",
                  "name": "DSS_W&S_TAX_HEAD_BOUNDARY",
                  "code": "",
                  "chartType": "table",
                  "filter": "",
                  "headers": [],
                  "tabName": "Boundary"
                }
              ]
            }
          ]
        },
        {
          "row": 7,
          "name": "DSS_SERVICE",
          "vizArray": [
            {
              "id": 231,
              "name": "DSS_STATE_WS_OVERVIEW",
              "dimensions": {
                "height": 350,
                "width": 12
              },
              "vizType": "metric-collection",
              "label": "",
              "noUnit": false,
              "isCollapsible": true,
              "charts": [
                {
                  "id": "wstotalApplications",
                  "name": "DSS_WS_TOTAL_APPLICATIONS",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                },
                {
                  "id": "wsSLACompliance",
                  "name": "DSS_WS_SLA_COMPLIANCE",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                },
                {
                  "id": "wstotalConnection",
                  "name": "DSS_WS_ACTIVE_CONNECTIONS",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                },
                {
                  "id": "wsActiveMeteredWaterConnection",
                  "name": "DSS_WS_ACTIVE_METERED_WATER_CONNECTIONS",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                },
                {
                  "id": "wsActiveNonMeteredWaterConnection",
                  "name": "DSS_WS_ACTIVE_NON_METERED_WATER_CONNECTIONS",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                },
                {
                  "id": "wsActiveSewerageConnection",
                  "name": "DSS_WS_ACTIVE_SEWERAGE_CONNECTIONS",
                  "code": "",
                  "chartType": "metric",
                  "filter": "",
                  "headers": []
                }
              ]
            },
            {
              "id": 232,
              "name": "DSS_W&S_CUMULATIVE_CONNECTION",
              "dimensions": {
                "height": 350,
                "width": 7
              },
              "vizType": "chart",
              "isCollapsible": false,
              "charts": [
                {
                  "id": "wscumulativeConnections",
                  "name": "Monthly",
                  "code": "",
                  "chartType": "line",
                  "filter": "",
                  "headers": []
                }
              ]
            }
          ]
        },
        {
          "row": 8,
          "name": "DSS_SERVICE",
          "vizArray": [
            {
              "id": 231,
              "name": "DSS_W&S_WATER_CONNECTION_BY_USAGE",
              "dimensions": {
                "height": 350,
                "width": 12
              },
              "vizType": "chart",
              "label": "",
              "noUnit": false,
              "isCollapsible": true,
              "charts": [
                {
                  "id": "wsWaterConsumersByUsageType",
                  "name": "",
                  "code": "",
                  "chartType": "donut",
                  "filter": "",
                  "headers": []
                }
              ]
            },
            {
              "id": 232,
              "name": "DSS_W&S_SEWERAGE_CONNECTION_BY_USAGE",
              "dimensions": {
                "height": 350,
                "width": 12
              },
              "vizType": "chart",
              "label": "",
              "noUnit": false,
              "isCollapsible": true,
              "charts": [
                {
                  "id": "wsSewerageConsumersByUsageType",
                  "name": "",
                  "code": "",
                  "chartType": "donut",
                  "filter": "",
                  "headers": []
                }
              ]
            },
            {
              "id": 233,
              "name": "DSS_W&S_CONNECTION_BY_CHANNEL",
              "dimensions": {
                "height": 350,
                "width": 12
              },
              "vizType": "chart",
              "label": "",
              "noUnit": false,
              "isCollapsible": true,
              "charts": [
                {
                  "id": "wsConsumersByChannel",
                  "name": "",
                  "code": "",
                  "chartType": "donut",
                  "filter": "",
                  "headers": []
                }
              ]
            }
          ]
        },
        {
          "row": 9,
          "name": "DSS_SERVICE",
          "vizArray": [
            {
              "id": 231,
              "name": "DSS_W&S_CONNECTION_AGEING",
              "dimensions": {
                "height": 350,
                "width": 12
              },
              "vizType": "chart",
              "label": "",
              "noUnit": false,
              "isCollapsible": true,
              "charts": [
                {
                  "id": "wsConnectionAgeingDDR",
                  "name": "DSS_W&S_CONNECTION_AGEING",
                  "code": "",
                  "chartType": "table",
                  "filter": "",
                  "headers": [],
                  "tabName": "Boundary"
                }
              ]
            }

          ]
        }
      ]
    }

Role Dashboard Mappings Configuration

In this, each role is mapped against the Dashboard which they are authorised to see. This was used earlier when the Role Action Mapping of eGov was not integrated.

Later, when the Role Action Mapping started controlling the dashboards to be seen on the client side, this configuration was just used to enable the dashboards for viewing.

{
  "_comment": "Holds mapping for each role with and its associated dashboards",
  "roles" : [
    {
      "_comment":"This role is super role which can access all the available dashboards: [other/new roles are suppose to be added]",
      "roleId": 6,
      "roleName" : "Admin",
      "isSuper" : "",
      "orgId": "",
      "dashboards": [
        {
          "name": "Water & Sewerage",
          "id": "ws"
        }
      ]
    },
    {
      "_comment":"This role is super role which can access all the available dashboards: [other/new roles are suppose to be added]",
      "roleId": 7,
      "roleName" : "Commissioner",
      "isSuper" : "",
      "orgId": "",
      "dashboards": [
        {
          "id": "ulb-ws"
        }
      ]
    }

  ]
}

MDMS Configuration

common-masters/uiCommonConstants.json

"ws": {
          "routePath": "/dashboard/ws",
          "isOrigin": true
      },
"ulb-ws": {
           "routePath": "/dashboard/ulb-ws",
           "isOrigin": true
          }

roleaction.json

 {
      "rolecode": "STADMIN",
      "actionid": {{PlaceHolder1}},
      "actioncode": "",
      "tenantId": "pb"
    }
    
    
    {
      "rolecode": "STADMIN",
      "actionid": {{PlaceHolder2}},
      "actioncode": "",
      "tenantId": "pb"
    },
     {
      "rolecode": "EMPLOYEE",
      "actionid": {{PlaceHolder2}},
      "actioncode": "",
      "tenantId": "pb"
    },  
     {
      "rolecode": "UC_EMP",
      "actionid": {{PlaceHolder2}},
      "actioncode": "",
      "tenantId": "pb"
    },

Action test.json

{
      "id": {{PlaceHolder1}},
      "name": "Dashboard Water Sewerage",
      "url": "/dashboard-analytics/dashboard/getDashboardConfig/ws",
      "parentModule": "",
      "displayName": "DSS",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "DSS",
      "code": "null",
      "path": ""
},
{
      "id": {{PlaceHolder2}},
      "name": "Dashboard Water Sewerage",
      "url": "url",
      "displayName": "Water Sewerage",
      "orderNumber": 11,
      "parentModule": "dss-dashboard",
      "enabled": true,
      "serviceCode": "DSS",
      "code": "null",
      "path": "Dashboard.Ws",
      "navigationURL": "/digit-ui/employee/dss/dashboard/ws",
      "leftIcon": "places:business-center",
      "rightIcon": ""
},
{
      "id": {{PlaceHolder3}},
      "name": "DSS Dashboard Charts",
      "url": "/dashboard-analytics/dashboard/getChartV2",
      "parentModule": "",
      "displayName": "DSS",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "DSS",
      "code": "null",
      "path": ""
}

Charts Overview

W&S-DSS consists of multiple graphs which represent the data of W&S. Each graph has its own configuration which will describe the chart and its type.

DSS consists of the following charts in W&S:

Revenue Tab

Overview
Total Cumulative Collection
Top ULB By Performance
Bottom ULB by Performance
W&S Collection by Usage Type
W&S Collection by Channel Type
W&S Key Financial Indicators
W&S Tax Heads

Service Tab

Overview
Total Cumulative Connection
Water Connection By Usage
Sewerage Connections By Usage
Connection By Channel
W&S Connection Ageing

Revenue Tab

Overview

The overview graph contains multiple data information as below in the selected time period.

Today’s Collection: This represents today’s collection amount for Water and Sewerage Application Fee + Consumption Charges.
Total Collection: This represents the total collection amount for Water and Sewerage Application Fee + Consumption Charges.
Target Collection: This represents the target collection amount for the Water and Sewerage connections.
Target Achievement: This represents the target achieved in percentage. This is calculated by the formula- (Total Collection/Target Collection)*100%

Total Cumulative Collection

line - this graph/chart is data representation on date histograms or date groupings.

Top ULB By Performance

This graph represents the ULBs based on the Target achieved in bar chart representation with the % of target achieved in descending order.

Bottom ULB by Performance

This graph represents the ULBs based on the target achieved in bar chart representation with the % of target achieved in ascending order.

W&S Collection by Usage Type

This graph shows the collection amount based on the usage/property type and this amount will change as per the denomination filter change.

W&S Collection by Channel Type

This graph shows the collection amount based on the collection channel type(eg-online, counter, etc) and this amount will change as per the denomination filter change.

W&S Key Financial Indicators

xtable type allows to the addition of multiple computed fields with the aggregated fields dynamically added.

On click of any district name will enter into drill-down charts, which will represent that specific District data.

On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.

W&S Tax Heads

table type allows to addition of multiple aggregated fields.

On click of any district name will enter into drill-down charts, which will represent that specific District data.

On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.

Service Tab

Overview

The overview graph contains multiple data information as below in the selected time period.

Total Applications: This represents the total number of applications for new, modify, and disconnection requests.
SLA Compliance: This represents the total SLA achieved in percentage.
Total Active Connections: This represents the total active water and sewerage connections.
Water-Metered Connections: This represents the total active metered water connections.
Water-Non Metered Connections: This represents the total active non-metered water connections.
Sewerage Connections: This represents the total active sewerage connections.