National Dashboard - UI Technical Doc

Overview

A decision support system (DSS) is a composite tool that collects, organizes and analyzes business data to facilitate quality decision-making for management, operations and planning. A well-designed DSS aids decision makers in compiling a variety of data from many sources: raw data, documents, personal knowledge from employees, management, executives and business models. DSS analysis helps organizations to identify and solve problems, and make decisions.

Code Git Repos: DIGIT-OSS/frontend/micro-ui/web/micro-ui-internals at master · egovernments/DIGIT-OSS

Enable National Dashboard: MDMS details

[
  {
    "moduleName": "tenant",
    "masterDetails": [
      {
        "name": "citymodule"
      }
    ]
  },
]

Enable the NDSS in the city module.

{
  active: true
  code: "NDSS"
  module: "NDSS"
}

Type Of Users

National Level Admin (NATADMIN)
State Level Admin (STADMIN)

Dashboard List

There are three type of dashboards -

Home page (refer figure 1).
Overview page (refer figure 2).
Module-level dashboard (refer figure 3).

Home page

The home page contains multiple cards - each card is clickable.

There are two types of cards, i.e, Overview card and module level card.

Overview and Module level card is differentiated by vizType,

Overview card: Clicking on the Overview card, redirects users to the overview page. vizType for Overview is collection.
Module Level card: Clicking on the Module level card, redirects users to the Module level dahsboard. vizType is module (i.e Property Tax, Trade License etc).

Request Payload For Dashboard Config

https://qa.digit.org/dashboard-analytics/dashboard/getDashboardConfig/NURT_DASHBOARD

auth-token: authenticates the request and fetches from the local storage key called Employee.token

DashboardConfig API Response

Visualizations: Key contains all configuration for displaying the visualization like rows with charts etc. - refer figure 1.3. In Figure 1.3, vizType key defines the module UI.

For Collection Chart & Module Chart refer figure 1

Visualizations List

In dashboardConfig response visualizations key contains all rows & charts details(refer figure 1.3).

Each row contains the visual details like name, vizType, noUnit, charts etc.(refer figure 1.3).

name - name of visualization

vizType - type of visualization like COLLECTION,MODULE,METRIC-COLLECTION, PERFORMING-METRIC,CHART

COLLECTION - contains collection data and displayed on the home page (refer figure 1)
MODULE - contains module level data and displayed on the home page (refer figure 1)
METRIC-COLLECTION - contains collection data and displayed on Overview/Module level page (refer figure 2.1)
PERFORMING-METRIC - contains top/bottom performing data displayed on Overview/Module level page (refer figure 2.2).
CHART - contains the below visualizations displayed on Overview/Module level page (refer figure 2.3 to figure 2.7).
1. PIE CHART (refer figure 2.3)
2. LINE CHART (refer figure 2.4)
3. BAR CHART (refer figure 2.5)
4. HORIZONTAL BAR CHART (refer figure 2.6)
5. TABLE CHART (refer figure 2.7)

List of visualizations

Figure: 2.1 Collection Metric

Figure: 2.2 Performance Metric

Figure: 2.3 Pie Chart

Figure: 2.4 Line Chart

Figure: 2.5 Bar Chart

Figure: 2.6 Horizontal Bar Chart

Figure: 2.7 Table Chart

Figure: 2.8 Global Filters

Figure: 2.9 Download & Share Button

Global Filters (figure 2.8)

Filters are loaded from MDMS API - https://egov-micro-dev.egovernments.org/egov-mdms-service/v1/_search

egov-mdms-data/nationalInfo.json at QA · egovernments/egov-mdms-data (github.com)

State is fetched from stateCode ULB from code

  {
        "stateCode": "Punjab",
        "stateName": "Punjab",
        "code": "pb.amritsar",
        "name": "Amritsar",
        "active": true,
        "module": "NationalDashboard"
      },

Denomination filter: Denomination filter offers three options to display the amount and number in a particular format.

Crore
Lakh
Unit

Denomination filter is not applied on the percentage and text (figure 2.10). Type of data is identified by symbol in plots of charts API.

Figure 2.10

Custom Date Filter

If duration < 15 days, data is displayed days wise.

If duration <= 30 days, data is displayed week-wise.

If duration >30, data is displayed monthly wise.

Tabs

Currently dashboard is having two types of tabs -

Revenue (figure: 4.1)
Service (figure: 4.1)

Tabs are identified by name in visualizations of config API.

Table chart with drilldown

Table chart visualizations has normal material UI data table features like search, sort etc.

In table response filter key & drillDownChartId has a value that indicates it is a drill-down table.

Cards

Each card header is localized and has an info icon with a tooltip option which displays the header and the description.
Number of cards in rows on the page is driven by the backend. The backend provides a row number to each card where it should be displayed.
Card contains an option icon that contains the image download and image share option.
Image download and share option use id from vizArray in order to differentiate each card on a page.

Download and Share (figure 2.9)

Download has two options - download as Image or PDF

Share: Share creates the Image/PDF and uploads it S3 using the below API and returns file id - /filestore/v1/files

Using file Id calls the following API - /filestore/v1/files/url

Each S3 image is shortened using the following API - /egov-url-shortening/shortener

Upload localization keys:

code: pre-defined key for back-end

message: message contains the value for the key

module: rainmaker-dss

locale: contains locale data

Contact eGov team for more details

Module name: rainmaker-dss

NPM Module Used

    "react-date-range": "1.3.0",
    "react-hook-form": "^6.7.0",
    "react-i18next": "^11.7.3",
    "react-query": "3.6.1",
    "react-redux": "^7.2.1",
    "react-router-dom": "^5.2.0",
    "react-table": "^7.6.1",
    "react-time-picker": "4.2.1",
    "recharts": "^2.0.9",

Note:: Consider this while pushing new State data - both MDMS state names and codes should be in sync

1. Map component : https://raw.githubusercontent.com/egovernments/egov-mdms-data/DEV/data/pb/dss-dashboard/dashboard-config.json

 {
              "type": "Polygon",
              "id": "MP",
              "properties": { "name": "Madhya Pradesh" },
              "arcs": [[-39, 142, -127, -66, -86]]
            },

Where id is state code and name is state name.

2. Global Filter: https://raw.githubusercontent.com/egovernments/egov-mdms-data/QA/data/pb/tenant/nationalInfo.json

   {
        "stateCode": "Punjab",
        "stateName": "Punjab",
        "code": "pb.amritsar",
        "name": "Amritsar",
        "active": true,
        "module": "NationalDashboard"
      },