National Dashboard-FireNoc Technical Documentation

FireNoc-National DSS 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 FireNoc.

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 firenoc 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 firenoc 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 FireNoc.

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 authorized 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

FireNoc-National DSS Consists of multiple graphs which represent the data of FireNoc. Each graph has its own configuration which will describe the chart and its type.

National DSS Consists of following charts in FireNoc:

FireNoc Page :

• Overview

• Total Cumulative Collection

• Total applications vs Provisional NOCs issued vs Actual NOCs issued

• Collection by Payment Mode

• Total NOCs issued by type

• Actual Fire NOCs by usage type

• Top 3 Performing States

• Bottom 3 Performing States

• Service Report

Overview:

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

• Today’s Collection : This represents the sum of revenue collected from issuance of a Provisional and Actual Fire NOC which is Application fee + NOC Issuance fee.

•  Total Collection : Sum of revenue collected from Fire NOC for the applied date filter.

• Total Applications : Total number of applications submitted for a new FireNOC.

• Provisional NOCs Issued : The Provisional NOC is to be obtained to ensure that the proposed constructions meet the fire safety compliant norms.

• Actual NOCs Issued : The Actual NOC is to be obtained to ensure that the proposed constructions meet the fire safety compliant norms.

• Avg. days to issue Provisional Fire NOC : Average number of days taken to issue a Provisional NOC.

• Avg. days to issue Actual Fire NOC : Average number of days taken to issue a Actual NOC.

• SLA Compliance (Actual FIre NOC) : % of Actual NOCs issued within SLA.

• SLA Compliance (Provisional FIre NOC) : % of Provisional NOCs issued within SLA.

Open

Total Cumulative Collection:

This Graph contains the Fire NOC collection amount information in the monthly base as a cumulative line graph for each Fire NOC 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.

Open

Total applications vs Provisional NOCs issued vs Actual NOCs issued :

This Graph contains the Fire NOC showing total applications submitted vs provisional NOCs issued vs actual NOCs issued for a given month 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.

Collection by Payment Mode : This will be a pie chart showing bifurcation of total collections by payment mode (online, cash, card, cheque) which is the sum of revenue collected from Fire NOC for the applied date filter.

Total NOCs issued by type : This will be a pie chart showing bifurcation of Total NOCs issued into Provisional and Actual Fire NOCs. Sum of Provisional and Actual Fire NOCs issued.

Actual Fire NOCs by usage type : This will be a pie chart showing a bifurcation of Actual Fire NOCs by usage type. Total number of Fire NOCs issued by concerned authority.

Top 3 Performing States : This card will show the Top 3 Performing States/ULBs/Wards based on % NOCs issued. Number of Fire NOCs issued / Number of applications depending on whether a user selects 'Provisional' or 'Actual'.

On click of Actual it shows the % of NOCs issued for Actual FireNocs.

On click of Provisional it shows the % of NOCs issued for Actual FireNocs.

On click of Show More it shows the information of all the states.

Bottom 3 Performing States : This card will show the Bottom 3 Performing States/ULBs/Wards based on % NOCs issued. Number of Fire NOCs issued / Number of applications depending on whether a user selects 'Provisional' or 'Actual'.

On click of Actual it shows the % of NOCs issued for Actual FireNocs.

On click of Provisional it shows the % of NOCs issued for Actual FireNocs.

On click of Show More it shows the information of all the states.

Service Report : This tabular chart representation graph shows multiple Fire NOC information like Total Collection, Applications Submitted, Provisional FireNoc issued, New FireNOC Issued, Average days to issue Provisional NOC, SLA Compliance (Provisional NOC), Average days to issue New NOC, SLA Compliance (New NOC). And this table 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.

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 state 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 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. Fire NOC is FIRENOC.

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 FireNoc- Dss:

The index that contains data for National-FireNoc is- firenoc-national-dashboard

The mapping for this index is:

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

Postman collection for National FireNoc- Dss:

https://www.getpostman.com/collections/2f7a283a42c695b2a52f