National Dashboard - PGR Technical Documentation

PGR-National Dashboard Documentation

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

As this revolves around a variety of Data Set, 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 flow of process. 

This document explains the steps on how to define the configurations for 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 pgr in this dashboard-analytics.
Here is the location : https://github.com/egovernments/configs/tree/qa/egov-dss-dashboards/dashboard-analytics

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

Description :

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 their 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 configuration and are easily changeable.

Here is the sample ChartApiConfiguration.json data for the National PGR.

Click here to check the complete configuration

Master Dashboard Configuration:

Master Dashboard Configuration is the main configuration which defines as which are the Dashboards which are 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:

Master Dashboard Configuration which was explained earlier hold 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 to be added:

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

National Dashboard consists of multiple graphs which represent the data of national pgr. Each graph has its own configuration which will describe the chart and its type.

National PGR consists of the following chart:

• Overview

• Cumulative Closed Complaints

• Total Complaints by Source

• Total Complaints by Status

• Complaint By Status

• Complaint By Department

• Complaint By Channel

• Event Duration Graph

• Unique Citizens

• Top Complaints

• Service Report

Overview:

The overview card contains metrics data information within a selected date range.

• Total Complaints: Number of complaints raised by citizens or employees. This is calculated by the formula (Open Complaints + Closed Complaints).

• Closed Complaints: Number of complaints successfully resolved by the concerned authorities. This is calculated by the formula (Resolved Complaints + Rejected Complaints).

• SLA Achievements: Percentage of complaints resolved within SLA. This is calculated by the formula (Resolved complaints within SLA/Total Complaints) * 100%

• Completion Rate: This represents the completion rate of raised complaints. This is calculated by the formula (Closed Complaints / Total Complaints) * 100%

  Open

  

Cumulative Closed Complaints:

This graph contains the Total Complaints, Closed Complaints, and Reopened Complaints information in the 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.

Open

Complaint By Channel:

This graph shows the total number of complaints categorized by channel (eg Mobile, Web, etc) and this will change as per the denomination filter change.

Complaint By Department:

This graph shows the total number of complaints categorized by department and this will change as per the denomination filter change.

Complaint By Status:

This graph shows the total number of complaints categorized by status and this will change as per the denomination filter change this also shows the % of the top 4 properties, the remaining properties will go under others category.

Total Complaints by Status:

This graph shows the data in horizontal bar representation and bars contain complaints categorized by status (eg Mobile App, Web, etc) in monthly wide and non-cumulative data.

Average Solution Time:

This graph shows the average of (start to end) in a workflow, irrespective of status on a monthly basis as a line graph.

Unique Citizens:

This graph shows the number of Unique Citizens who have filed complaints on a monthly basis as a line graph.

Top Complaints:

This graph shows the total complaints based on category with the category having most of the registered complaints on top.

Service Report:

This shows the data in the form of xtable categorized with two tabs, State and Department. State tab shows the data in the following order State → District → Ward of the following metrics Closed Complaints, Reopened Complaints, Open Complaints, Total Complaints, Completion Rate, and SLA Achieved. And Department tab shows data based on the department category of the same metrics as in the State the tab.

This tabular chart representation graph shows multiple National PGR informations like Total Complaints, Closed Complaints, Opened Complaints, Reopened Complaints, Resolved Complaints, Assigned Complaints, Reassigned Complaints, Rejected Complaints, Completion Rate (in %) and SLA Achievement (in %). And this table have two tabs, one is for State level where it shows the data in state level and also has the drill down chart for each state to ulb and from ulb to ward level data for the same, and another is for Department level where it shows the data for department category.

The service report contains metrics data information within a selected date range.

• Total Complaints: Number of complaints raised by citizens or employees. This is calculated by the formula (Open Complaints + Closed Complaints).

• Closed Complaints: Number of complaints successfully resolved by the concerned authorities. This is calculated by the formula (Resolved Complaints + Rejected Complaints).

• Resolved Complaints: Number of complaints that are marked as done by last-mile employees and await citizen's feedback.

• Open Complaints: Number of complaints that have been filed by the citizen and await further action (assignment). This is calculated by the formula (Reopened Complaints + Assigned Complaints + Reassigned Complaints).

• Reopened Complaints: Number of complaints reopened by the citizen (directly/ via counter employee) due to the unsuccessful resolution of complaint earlier.

• Assigned Complaints: Number of complaints that have been assigned to an individual of the respective department.

• Reassigned Complaints: Number of complaints for which a reassignment has been requested by the last mile employee.

• Rejected Complaints: Number of complaints that have been terminated by the redressal officer. In such cases, citizens will have to file a new complaint.

• SLA Achievements: Percentage of complaints resolved within SLA. This is calculated by the formula (Resolved complaints within SLA/Total Complaints) * 100%

• Completion Rate: This represents the completion rate of raised complaints. This is calculated by the formula (Closed Complaints / Total Complaints) * 100%

xtable type allows to add 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 state name will enter into drill down charts, which will represents 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.

On click of department tab will navigate to Departments and each department shows the specific data regarding that department.

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 configuration we will get it as 25. if value is 22.56 round of value will be 23.
This can be used for insights configuration as well for overview graph.

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 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 out 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. Facial Sludge Management is fsm.

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 filter 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 as performance wise.

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

xtable - represents a advanced feature of table, it has addition capabilities for dynamic adding header values.

valueType : In any case of data, the values which are sent to 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 amount from 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 aggregation on 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. In these kinds of cases, what is the action that has to be performed on that 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 it. 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 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. 

Index Properties of National PGR:

The index that contains data for National-PGR is- pgr-national-dashboard

The mapping for this index is:

The following is the table that describes the properties mentioned above:

Postman collection for pgr-national: https://www.getpostman.com/collections/11732dbcf9237ed73b8b