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

State DSS - mCollect

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, it is just a configuration away from getting the newly introduced scenario involved in this flow of the process.

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. Which shall be later used for visualizations and graphical representations.

Analytics Configurations: Analytics contains multiple configurations. we need to add the changes related to mCollect 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, the visualization code, which happens to be the key, will have its properties configured as a part of the configuration and are easily changeable.

Here is the sample ChartApiConfiguration.json data for the mCollect.

Click here for the complete configuration

Master Dashboard Configuration

The master dashboard configuration is the main configuration which defines the Dashboards to be painted on screen. It includes all the visualizations, their groups, the charts which comes within them and even their dimensions as what should be their height and width.

Click here for the complete configuration

Role Dashboard Mappings Configuration

The master dashboard configuration explained earlier holds 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 a 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 for the complete configuration

MDMS Configuration To Be Added

common-masters/uiCommonConstants.json

Click here for the complete configuration

roleaction.json

Click here for the complete configuration

Action test.json

Click here for complete configurations

Chart Details

mCollect-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 mCollect:

  • Overview

  • Total Cumulative Collection

  • Receipts by Payment Mode

  • Collection By Payment Mode

  • Challan Count by Status

  • Receipts Count By Status

  • Collection By Status

  • Top Categories Collections

  • Monthly Collections

  • Collection Report

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 mCollect

  • Total Collection: This represents the total collection amount for mCollect

  • Total Challans: This represents the total number of challans created.

  • Total Receipts: This represents the total number of receipts.

  • Total Categories: Number of categories against which miscellaneous collections have been made.

Total Cumulative Collection: This Graph contains the mCollect collection amount information on a monthly base as a cumulative line graph. This will change as per the denomination amount filter selection.

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

Receipts by Payment Mode: This graph represents the number of receipts according to the payment mode used.

Collection by Payment Mode: This graph represents the total collection according to the payment mode used.

Challan Count By Status: This graph shows the total number of challans according to status

Receipts Count by Status: This graph shows the total number of receipts according to status

Collection by Status: This graph shows the total collection according to status

Top Categories Collection: This graph shows the category-wise collection for all the categories in descending order.

Monthly Collections: This shows the monthly break-up of total collections and the total number of receipts.

Collection Report: This tabular chart representation graph shows multiple mCollect information like Total Challans, Total Collection and the total number of receipts. This table also shows the data at the district level and the drill-down chart for each district to ULB and from ULBs 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.

Clicking on any district name drills down charts to provide the data specific to the listed District.

Clicking on the ULB navigates to the wards for the specified ULB and displays the ward-specific data.

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.

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

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 donuts

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

perform - this chart represents groping data 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 the capabilities for dynamically adding header values.

valueType: In any instance of data, the values which are sent for plotting, 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.

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 Responses, the name of the aggregation in the query will be an easy bet. These aggregation paths will have the names of Aggregation in them.

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.

PreviousRe-Indexing The mCollect Service
NextCurrent Bill Cancellation UI Flow

Was this helpful?