Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

W&S - National Dashboard

Technical document

Overview

There are two dimensions to DSS. The first refers to the process where the data is pooled to ElasticSearch and the second relates to the way the data is fetched, aggregated, computed, transformed and sent across.

The DSS processes are easily configurable and this enables users to configure new analytics insights using a wide range of data sets.

This document defines the configuration steps for fetching analytical insights on the DSS for the Water & Sewerage module.

Key Concepts

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

Analytics Configurations: Analytics contains multiple configurations. Add the changes related to FSM in the dashboard-analytics configuration file. File location : configs/egov-dss-dashboards/dashboard-analytics at qa · egovernments/configs List of configurations that need to be changed to run FSM successfully.

  1. Chart API Configuration

  2. Master Dashboard Configuration

  3. Role Dashboard Mappings Configuration

Configuration Details

Chart API Configuration

Each visualization has its own properties. The visualization is derived from different data sources or a combination of data sources.

The Chart API Configuration Document is used to configure each visualization and its properties. The Visualization Code is the key and its properties are easily configurable.

Sample ChartApiConfiguration.json data for the W&S

Click here to check the complete configuration

Master Dashboard Configuration

Master Dashboard Configuration is the main configuration that defines the key insights and visualizations to be painted on the screen.

It includes all the visualizations, the groups, the charts embedded within them and even the dimensions in terms of height and width.

Sample ChartApiConfiguration.json data for the W&S

Click here for the complete configuration.

Role Dashboard Mappings Configuration

The master dashboard configuration explained earlier contains the list of available dashboards. Map the roles to specific dashboard views based on the user role requirements. The configuration allows each role to be mapped to authorized dashboard views.

Click here to check the configuration

MDMS Configuration

Use the configuration link here to add MDMS details - common-masters/uiCommonConstants.json

Click here to check the complete configuration

roleaction.json

Click here to check the complete configuration

Action test.json

Click here to check the complete configuration

W&S National DSS Charts

W&S-National DSS consists of multiple graphs that represent the data of W&S. Each graph has its own configuration that describes the chart and its type.

National 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 listed below:

  • 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 illustrates the Water and Sewerage collection amount information on a monthly basis. The insights are represented in distinct cumulative line graphs for water and sewerage collections. The graph changes as per the denomination amount filter selection.

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

Top State By Performance

This graph represents the States performance based on the % of target achieved in the form of bar charts in descending order.

On the click of the Show More button the system displays the information of all the states as seen in the screenshot below:

Bottom State by Performance

This graph represents the States performance based on the % of target achieved in the form of bar charts in ascending order.

On the click of the Show More button, the system displays the information of all the states as seen in the screenshot below:

W&S Collection by Usage Type

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

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 changes as per the selected denomination filter.

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 %). The table shows the data at the district level and provides a drill-down chart for each district to the ULB level and from the ULB level to the ward level.

xtable type adds multiple computed fields with the aggregated dynamic fields.

To add multiple computed columns -

  • provide the actionName in the following format - actionNameComputedField<T> interface

  • provide the fields [] names as it exists in the query key

  • provide the newField as a name to reflect the computed details

Clicking on any district name provides the drill-down charts, that represent data at the district level.

Clicking on the ULB offers a drill-down view of the data at the ward level.

W&S Tax Heads

The tabular chart representation graph shows multiple W&S information like Total Collection, Penalty, Interest and Target Collection. The table provides the view of data at the district level. Drill-down charts are available for each district to ULB level and for each ULB to ward level.

table type allows the addition of multiple aggregated fields.

Clicking on the distinct name provides a drill-down view of data at the ULB level.

Clicking on the ULB name provides a drill-down view of data at the ward level.

Service Tab

Overview - The overview graph offers insights on multiple data items listed below for a selected time period.

  • Total Applications: the total number of applications submitted for new, modify, and disconnection requests

  • SLA Compliance: the total SLA observed in percentage

  • Total Active Connections: the total active water and sewerage connections

  • Water-Metered Connections: the total active metered water connections

  • Water-Non-MeteredInformation Connections: the total active non-metered water connections

  • Sewerage Connections: the total active sewerage connections

Cumulative Connections

This graph provides insights into the Water and Sewerage connections on a monthly basis in the form of a cumulative line graph. Distinct line graphs are illustrated for water and sewerage connections.

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

Water Connections by Usage Type

This graph provides the active water connection insights based on the usage/property type.

Sewerage Connections by Usage Type

This graph offers the active Sewerage connection details based on the usage/property type.

W&S Connections by Channel Type

This graph provides the active water and sewerage connection details by channel type (eg-online, counter, etc).

W&S Connection Ageing

This tabular chart graph provides insights on the submitted W&S applications that are 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 are shown in the chart. The data is visible at the district level with the drill-down facility down to the State level to the ULB level and finally to the Ward level.

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

To add multiple computed columns -

  • provide the actionName in the following format - actionNameComputedField<T> interface

  • provide the fields [] names as it exists in the query key

  • provide the newField as a name to reflect the computed details

Clicking on the district or State name provides a drill-down view of the data at the ULB level.

Clicking on the ULB name provides a drill-down view of the data at the ward level.

Newly Introduced Property Configuration

isRoundOff: This property is introduced to round off the decimal values. For example, the value 25.43 is rounded off to 25 using the isRoundOff property configuration. The value 22.56 is rounded off to 23. This configuration property is used for insights configuration and overview graphs.

Common Property Configuration

Key(eg: fsmTotalrequest): This is the Visualization Code used to configure visualization details. It allows the client application to identify the visualization for display.

chartName: The name of the chart to be used as a label on the dashboard. The name of the chart is the detailed name. In this configuration, the name of the chart is the localization code used by the client side.

queries: Some visualizations are derived from specific data sources. While some others are derived from different data sources and are combined together to get a meaningful representation. The queries of aggregation used to fetch out the right data in the right aggregated format are configured here.

queries.module: The module/domain level, on which the query is applied on. The Water and Sewerage module is referred to as W&S.

queries.indexName: This property allows the configuration of the name of the index upon which the query is executed.

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

queries.requestQueryMap: Client requests carry certain fields that require filtering. The parameters specified in the client request are different from the parameters in each of the indexed documents. This mapping is maintained to map the request parameters to the ElasticSearch Document parameters.

queries.dateRefField: Each of the 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. This configuration parameter maintains the date field index.

chartType: This configuration field identifies the type of chart/visualization data to be used to represent data insights.

Available Chart Types

metric - this presents the aggregated amount/value for records filtered by the query

pie - this presents grouped data in the form of line graphs, bar graphs, pie charts or donuts

line - this graph/chart is data representation using dated histograms or grouped data

perform - this chart groups data performance-wise

table - presents data grouped into rows and columns with distinct headers

xtable - represents an advanced feature of the table with dynamic capabilities for adding header values.

valueType: In any case of data, the values sent for plotting, might be in percentage, sometimes an amount or sometimes just a count. This field allows the configuration of the type of value represented by the data in the visualization - that is whether it reflects a number, a percentage or an amount.

action: Some of the visualizations are not just aggregation of the data source. There might be some cases where we have to do a post aggregation computation. For Example, in the case of Top 3 Performing ULBs, the Target and Total Collection is obtained and then the percentage is calculated. This parameter defines the action that has to be performed on the data obtained.

documentType: This parameter defines the type of document upon which the query has to be executed.

drillChart: This field adds the drill-down code for the visualization in case the chart offers drill-down. This is used by the client service to manage drill-downs.

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

insights: This field shows the data in comparison to last year with arrow symbols that indicate the % increase or decrease.

comment: In order to display information on the “i” symbol of each visualization. This field captures any additional information linked to visualization.

National W&S-DSS - Index Properties

The index that contains data for National-W&S is- ws-national-dashboard

The mapping for this index is:

The following table describes the properties mentioned above:

Attributes

Definition

Breakup

ulb

The district or region for which the data is ingested.

Nil

state

The ULB name for which the data is ingested.

Nil

ward

The ward for which the data is ingested.

Nil

transactions

Number of transactions related to WS/SW module on a given date

Nil

connectionsCreated

Number of connections related to WS/SW module on a given date.

Breakup by: 1.) channel type(Counter, ONLINE, CSC, SYSTEM) and 2.) connection type(WATER.METERED, WATER.NONMETERED, SEWERAGE) has to be provided

todaysCollection

Total collection related to WS/SW module on a given date

Breakup by: 1.)usage type(Domestic, Commercial, Institutional, Domestic SLC, Domestic Exempted,Commercial Motor,etc), 2.)payment channel type(System, Paytm, Field, RazorPay, PayU, BBPS, POS, Sewakendra, Freecharge), 3.) tax head(INTEREST,LATE.CHARGES, ADVANCE, CURRENT.CHARGES, ARREAR.CHARGES), and 4.) connection type(WATER.METERED, WATER.NONMETERED, SEWERAGE) has to be provided

waterConnections

new connections created on the given date

Breakup by: 1.) meter type(METERED, NON.METERED), 2.) usage(Domestic, Commercial, Residential, Institutional, Domestic Exempted) and 3.) channel(Counter, ONLINE, CSC, SYSTEM)

sewerageConnections

new sewreage connections created on the given date

Breakup by: 1.) usage(Domestic, Commercial, Residential, Institutional, Domestic Exempted) and 2.) channel(ONLINE, CSC, SYSTEM)

pendingConnections

pending connections on the given date

Breakup by:

duration(0to3Days, 3to7Days, 7to15Days, MoreThan15Days)

slaCompliance

Percentage of complaints that are resolved within SLA till the given date.

Nil

todaysTotalApplications

# of Applications created on the given date

Nil

todaysClosedApplications

# of Applications closed on the given date

Nil

todaysCompletedApplicationsWithinSLA

# of Applications closed on the given date within SLA

Nil

Postman Collection - National W&S-DSS

https://www.getpostman.com/collections/5d3bb33f27dc4528c103

PreviousNational Dashboard Adaptor ServiceNextProperty Tax - National Dashboard

Last updated

Was this helpful?