Edit

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: configs/egov-dss-dashboards/dashboard-analytics at qa · egovernments/configs Below is a list of configurations that need to be changed to run W&S 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. 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.

Click here to check the complete configuration

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.

Click here for the complete configuration

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.

Click here to check the configuration

MDMS Configuration

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

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.

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.

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.

Postman collection for W&S-dss: https://www.getpostman.com/collections/f346eea97268ac94888b,

https://www.getpostman.com/collections/bb410e74c00cea0d381c

PreviousLegacy/Re-Indexing the Water & Sewerage ServiceNextWater Calculator Service

Last updated

Was this helpful?