1 of 100

v1.2

Introducing mGramSeva

Mobile app designed to collect, manage revenue and expenditure

About mGramSeva

A mobile-based application that enables the gram panchayat water committee to collect & manage revenue and expenditure.

mGramSeva is an application that has been developed as part of the exemplar in Punjab. It enables rural local bodies to manage revenue and expenditures related to water supply projects using a mobile app. The app is meant for members of the water management committee and collection agents. The collection agents can add consumers (or households), and generate bills and receipt acknowledgements.

Problems Addressed

The Finance Department and Water Supply and Sanitation Department have limited visibility over the fiscal sustainability of water schemes and get hit by the sudden demand for large funds to clear electricity bills.

The Department of Water Supply & Sanitation (DWSS) faces several problems due to the lack of financial visibility of schemes:

Unreliable and poor-quality of water
Inability to collect adequate water charges
Lack of visibility of revenue and expenditure information
Large amounts of pending electricity bills

mGramSeva helps digitise revenue and expense records of Gram Panchayat Water Supply Committees. The dashboards and data insights provide visibility of the GPWSC financial status to the DWSS and FD officials.

The app provides:

Digital way to maintain the revenue and expenditure records
Easy to share reports over WhatsApp
Updated information on consumer satisfaction/quality of services
Dashboards for a snapshot of collections and expenditures to the Sarpanch/other GP officials

Approach

mGramSeva posts standardized fiscal events on the fiscal information exchange (FIX) platform. The events are processed and provide rich insights to the users through the fiscal sustainability dashboards.

The key benefits of using the mGramSeva app are listed below:

Digital book-keeping
Maintain all receipt and expense records in digital format
Easy consumer and vendor account generation and updation
Easy to use and environmentally friendly

Features

mGramSeva offers multiple features required to manage revenues and expenditures (listed below).

Section Overview

This section contains all docs and information required to understand the mGramSeva, its key features, functional scope, and configuration details. Click on the links below to learn more about deploying, configuring, customizing, and using the mGramSeva app.

Navigation Tips

Click on the embedded links within the content to browse topic details
Use the Contents links available on the right side of the screen to move to a specific heading

Contact Us

Platform

Release Notes

mGramseva 1.2 Release Notes

Release Summary

mGramSeva 1.2 release features enhancements with a few functional changes and non-functional changes.

Create and update consumers with the option to pay penalty and advance
Allow users to collect advance payment
Penalty amount addition if the due amount is not paid before the due date
Addition of father/husband column in household register
Receipt and bill PDF changes based on advance and penalty amount and localization fixes
Dashboard data and trend graph data mismatch fixes
Non-functional: After flutter upgradation, APK was not working in Android > 12 fixes

New ‌Feature Additions/Enhancements

Feature

Description

Road Map

The below enhancements in reports and dashboard are addressed for tracking/viewing Advance and Penalty details

P
PFM-1739 Ch
PFM- Cha

Other Enhancements

PF C

Success Metrics

Primary KPI for overall mGramSeva -

Additional: % of consumers paying and GPWSC collecting advance % of the advance amount of revenue collected month on month Outcomes: * Increased revenue * Timely payments

Known Issues

- - -

Document Resources & Links

UI Technical Documents

Backend Service Documents

Web Caching

Steps to remove the cache data whenever a new build is deployed

Package Used

The build number of the application is compared every time we hit the URL. If the build number is not present in the local storage or the build number does not match the existing build number then the local storage cache is deleted.

Test Cases

mGramSeva 1.2 release

Click here to download the test cases.

Architecture

mGramSeva architecture details

Service Architecture

mGramSeva is built on top of the Platform. It consists of distinct layers listed below.

Back End

Core Services

Demo video

A quick walkthrough of mGramSeva

Detailed version -

Configure mGramSeva

mGramSeva service configuration docs

Technical User Docs

mGramSeva technical documents

This section contains mGramSeva technical documents.

Topics in this section:

Application Structure

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

Firebase Analytics Integration

About Firebase Analytics

Google Analytics helps you understand how people use the web and Android apps. Analytics helps you understand how the users behave, so we can make informed decisions about how to market our app.

Integration Testing

About Integration Testing

Integration testing (also called end-to-end testing or GUI testing) is used to simulate a user interacting with your app by doing things like clicking buttons, selecting items, scrolling items, etc. Integration testing is used to test how individual pieces work together as a whole or capture the performance of an application running on a real device.

Plugins Used

integration_test

Integration Test Setup

We declared the integration_test package in pubspec.yaml as shown in the img above.

The test_driver directory contains the integration_test_driver.dart file. (The folder structure is shown in image above). The integration driver is called from this file.
The integration_test directory contains the test script files of different screens.
The Test Inputs directory contains the test_inputs.dart file. This file has the user actions inputs in json format. We can change user actions in this file.

Integration Test Run

There are two ways to start the integration testing:

To run the integration test on virtual emulator / mobile, run the command on your terminal : cd ./frontend/mgramseva && flutter drive --driver=test_driver/integration_test_driver.dart --target=integration_test/login_test.dart

(...or...)

Go to ./frontend/mgramseva/utils/execute_integration.sh and run the execute_integration.sh file on the virtual emulator / mobile. The integration test will start.

File Path

User actions Inputs - .frontend/mgramseva/integration_test/Test Inputs/test_inputs.dart

Integration Test Driver - .frontend/mgramseva/test_driver/integration_test_driver.dart

Execute Integration Test - .frontend/mgramseva/utils/execute_integration.sh

Reference Links

All content on this page by is licensed under a .

Backend Services

mGramSeva backend service details

This section contains the backend service docs for mGramSeva detailing the service scope, integration steps, and deployment of these services.

Browse the listed services below:

mGramSeva - Water Services mGramSeva - Water Service Calculator mGramSeva e-Challan Service mGramSeva - User Service mGramSeva - Billing Service mGramSeva - User OTP iFix Adapter Integration Service mGramSeva - Rollout Dashboard mGramSeva Scheduler

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

iFix Adapter Integration Service

Objective

The purpose of the mGramSeva IFIX adapter service is to push the demand, bill, and payment events to IFIX from the mGramSeva.

Overview

Tech User Manual

Home Page

Overview

Users are redirected to the home page screen after successful login. This screen consists of multiple sections and user interactions. If the user is mapped to multiple tenants then a dropdown appears. The user can select the desired tenant to proceed further. Once the user selects the tenant, the feature cards are displayed on the screen based on the roles mapped for the selected tenant.

Consumer Details

Expenses

Dashboards

Consumer Feedback

Overview

Users can provide their feedback by giving a rating. It's an Open URL. It doesn’t require any Authentication user.

Link → {baseURL}mgramseva/feedBack?paymentId={}&connectionno={}&tenantId={}

Users can switch to multiple languages.

After submitting the feedback, users are navigated to the feedback submitted successfully acknowledgement screen.

mGramSeva UI

UI Mockups

mGramSeva UI

mGramSeva is a Hybrid Application(web + App(Android + IOS)) built utilising Open Source Framework Flutter.

CrossPlatform Application
Faster
Single Codebase - Easy To Maintain

Enablement toolkits

List of actions required to go live in the new State for the mGramSeva module

AWS Installation Setting up Services

AWS Installation

These all steps need to be done-:

Setup AWS Account

A basic knowledge of AWS is required before setting up an AWS account. Below are the key pre-requisites:-

Refer to the details here.

Follow the steps in this doc to setup the AWS account.

Certificate Purchase

Currently, we are using the LetEncrypt SSL certificate which is free. However, there is a catch here. The LetsEncrypt certificate is valid only for 3 months (90 days). Post 90 days this has be renewed manually. There are few paid ones available globally.

Setup Git Repository

Overview

This page provides step-by-step details on setting up a git repo for code, configs, V1 MDMS, and Infra As Code.

Steps

Create Git Account In The Client Name

Overview

This page provides the steps to follow to create a Git account in the client name.

Steps

Setting up Services

After AWS installation we need to setup some services which are as follows :-

Getting Started With DIGIT Creating Users Loading Employees For mGramSeva Loading Consumers For mGramSeva Localisation Module Updating Master Rate for Mgramseva Create Consumer API Create User API SMS Template mGramSeva MDMS Create New Tenant Workflow

Loading Consumers For mGramSeva

Overview

This page provides step-by-step instructions for using a Python script to create consumers for mGramSeva. Follow these guidelines to load consumer data into the system using the Python script provided.

Steps

Product Docs

Functional Docs

mGramSeva functional details

Login & Forgot Password

Overview

The users receive a link via SMS. Clicking on this link redirects the users to the login page of the mGramSeva app. The users can log in from this screen or even reset their password in case they are logging in for the first time. The mGramSeva application link initiates from this screen.

Language Selection

The link in the SMS redirects users to this screen which is the first screen which is the language selection screen. The user selects the preferred language and clicks on Continue. English, Hindi, and Punjabi are the supported languages with Punjabi as the default language. Localization in the screens is displayed based on the language selected.

User ID and Password Entry

The user enters the User ID, which is the registered mobile number of the user, and the system-generated password. Clicking on the Continue button logs in the user.

Forgot Password

The Forgot Password link navigates the user to the password reset screen.

The user is redirected to the password reset screen where they enter the OTP received on the registered mobile number. The next screen prompts the user to enter a new password and then confirm the same. This is similar to the first-time login screen. Clicking on Submit displays the acknowledgement screen. Clicking on the Continue to Login button on the acknowledgement screen takes the user to the login page.

The user is redirected to the home page of the application which displays the menu options based on the mapped user role.

Billing - Bulk Demand Generation

All Gram Panchayats have a monthly billing cycle for water charges. The Scheduler automatically triggers on the “X” date of every month to generate demand and raise bills for non-metered connections.

Metered connections do not fall under bulk demand generation

For the first month of go-live, it is only the arrears and no demand that is generated hence there is no bill to collect payments.

mGramSeva MDMS

Overview

mGramSeva's Master Data Management System (MDMS) is organized into several folders, each containing essential JSON files that define various aspects of the application's configuration. This documentation provides an overview of the key folders and their respective files, along with a description of the data contained within each file.

Steps

1.

This folder contains the actions-test.json file, which defines various API endpoints along with their configurations.

id: Unique identifier for the API endpoint. Increase id with respect to id present in action-test.json file.
name: Name of the endpoint.
url: URL of the API endpoint.

2.

This folder contains the roleactions.json file, which associates roles with action IDs.

rolecode: Code representing the role.
actionid: Action ID associated with the role, linking to entries in actions-test.json.
actioncode: Additional code for the action if needed.

This folder contains the roles.json file, defining roles in the system.

code: Code representing the role.
name: Name of the role.
description: Description of the role.

4.

This folder contains various JSON files related to billing services.

4.1 BusinessService.json

Defines business services, such as expenses like electricity bills and salaries.

businessService: Identifier for the business service.
code: Code representing the business service.
collectionModesNotAllowed: Collection modes not allowed for the service.

4.2 `PaymentService.json`

This file, located in the billingservice folder, provides configurations for payment services within the Billing Service module.

tenantId: The identifier for the tenant associated with the configuration.
moduleName: The name of the module, in this case, "BillingService."
PaymentService: An array containing configurations for different payment services.

Payment Service Configuration:

businessService: Identifier for the business service.
code: Code representing the payment service.
collectionModesNotAllowed: Array specifying modes of payment not allowed for this service.

This configuration specifies the payment modes not allowed for the "ws-services-calculation" business service, whether part payment and advance payment are allowed, the demand update time, voucher creation status, Bill Genie URL, and bill amendment status.

4.3 `TaxHeadMaster.json`

This file is responsible for defining the various charges and taxes which are going to be configured in the application.

4.4 `TaxPeriod.json`

This file is used to define the number of financial years which are supported in each tax head.

This folder contains various JSON files related to ws-services-masters.

6. This folder contains various JSON files related to ws-services-calculations.

This folder contains various JSON files related to property tax.

This folder contains expense type in JSON format.

All (1 to 8 points) are state-level changes.

9. (City level changes for every city there is one folder in MDMS)

For each tenant, there is a unique folder containing three subfolders, each with its specific configuration files.

1. `businessservice.json` - Billing Service Configuration

This file, located in the billing service folder, provides tenant-specific configurations for the Billing Service module. It is similar to the global BusinessService.json configuration but is specific to the tenant.

2. `boundary-data.json` - Location Boundary Data Configuration

This file, located in the egov-location folder contains boundary data specific to the tenant.

Details of the structure and content of this file would be specific to the actual data in the system. Please refer to the specific boundary-data.json file for detailed information.

3. `WCBillingSlab.json` - Water Connection Billing Slab Configuration

This file, found in the ws-services-calculation folder defines billing slabs for water connection based on building type and connection type.

id: Unique identifier for the billing slab.
buildingType: Type of the building (e.g., RESIDENTIAL).
connectionType: Type of connection (e.g., Metered).

This configuration is used to determine rates for water consumption based on the specified billing slab criteria.

There is a folder in the MDMS which contains all tenants in file.

Collect Payment

Overview

The Revenue Collector uses the Collect Payment screen to collect payment against the demand generated for metered and non-metered connections or any arrears.

Collect Payment card is available on the home screen to the user role having the COLLECTION_OPERATOR permission.

Link → {base url}/mgramseva/household/details/collectPayment

User Interaction On Screen

Users can pay the total due amount that is set by default.
Or, users can also pay an advance amount or partial amount by changing the value in the payment amount field to a higher or lower value. If a partial amount is to be paid, then users need to provide a lower amount than the total due amount. If the advance amount is to be paid, users need to provide a higher amount than the total due amount.
Clicking on Collect Payment opens a confirmation popup to confirm if the amount entered is correct.

Logic Implemented For Advance

billing-service/demand/_search API is used to calculate the advance amount for the current bill. The advance amount is fetched from the logic - if taxHeadMasterCode is 'WS_ADVANCE_CARRYFORWARD'. This has two properties - collection amount and tax amount. The tax amount is the advance amount that is added to the system and the collection amount is the amount utilised from the total advance amount. We can get the current advance from the taxAmount - collectionAmount.

Logic Implemented For Time Penalty

ws-calculator/waterCalculator/_getPenaltyDetails API is used to calculate the Time Penalty amount. The time penalty amount is fetched from the logic - if taxHeadMasterCode is'WS_TIME_PENALTY'. The time penalty amount is retrieved from the tax amount property of the latest demand.

The due date is calculated by adding the billexpirtyDate days to the demand generation date.

If the due date is crossed, billing-service/demand/_search API gives the Time Penalty applied.

Logic Implemented For First Demand Penalty

billing-service/demand/_search API gives the Normal Penalty. The Penalty placeholder in the bill details is visible if it is the first demand and has the taxHeadMasterCode as 10201.

Logic Implemented For Arrears Breakup

The arrears are broken into 'BL_(TaxHeadCode)' fetched from Bill Details-->Bill Account Details --> Tax Head Code. The amount of particular arrears is similar to the Bill Details--> Amount from the Fetch Bill API.

(For instance, if there are two bills with tax head codes is 10101 and 10102, then arrears break up is represented as BL_10101(Water Charges) with the corresponding amount and BL_10102(Water Charges-Arrears) with the corresponding amount).

Note:

The “Penalty” details displayed under “Bill Details“ section is displayed only if the config flag “Penalty enabled” is set as true. If it is set as false, then the penalty details is not displayed.
The “Advance” details displayed under “Bill Details“ section is displayed only if the config flag “Advance enabled” is set as true. If it is set as false, then the advance details is not displayed.

Files Path

Primary Files:

Field Validations

Fields

Validations

API Details

Stack

1 → Home Screen. + Search Connection Screen + Household Results + Household Details Screen + Collect Payment Screen

Pop → Household Details Screen

Widgets utilised from Library

mGramSeva Scheduler

About Schedulers

Schedulers are designed to run a particular service at a scheduled time, without triggering manually. We can have multiple schedulers for an application. It will consider the GMT time format only.

How CronJob Works

The python script (name) would read the mdms-read-cronjob json from the MDMS service which users CRONJOB user for a token to access the MDMS service.

Try to identify the API's configured in this mdms with the argument passed while invoking the script.

With the identified configs from the mdms, the script calls the respective API configured there.

mGramSeva Schedulers

Total 7 schedulers are available in the mGramSeva: _schedulerTodaysCollection: This scheduler will run daily to send the day collection amount to the collection employee.

_jobscheduler/true: This is to send the notification to the ULB employee when the bulk demand auto-generation is failed.

_schedulermarkexpensebill: This scheduler is used to mark the expense as paid for the paid expenses once for every fortnight.

_schedulernewexpenditure: This is used to send the notification once for every fortnight regarding the no of expenditures created.

_schedulermonthsummary: This is to send the monthly summary details to the ULB employee. _schedulerpendingcollection: This is to send the total pending amount details to the respective ULB employee user once every fortnight.

_jobscheduler/false: This is used to generate the bulk demand automatically once every month.

As we have 7 different schedulers in mGramSeva which will be running in 4 different time slots so we have to configure, all of them run the same python scripts with the different arguments which you can see in the file under command -> args

The Time of the scheduler to run should be configured under cron-> schedule option.

Example of failedBulkDemand scheduler.

You can observe -

command->args value is failedbulkdemand ( through which python script understand to invoke only api configured in mdms-read-cronjob mdms json file with the name as “failedbulkdemand”
cron->schedule value is “ 30 3 5 * *” which define the time to kick this scheduler i.e at 3.30 on 5th day of every month. As the crontab follows GMT timezone converting this time to IST this jobs run on 9am of on 5th day of every month

helps to define the pattern for the schedule cron.

Configuration

Infraops Configuration Changes

PriorNote: In DevOps for every configuration app name changes according to the name of the cron job file given and the schedule will change according to the time set, and the argument will be as per the job name given in MDMS configuration.

labels: app: monthly-cronjob // This name will change based on the cronjob scheduler we are using group: mdms-read-cronjob // this is the same for all as we are using the same python script

cron: schedule: 30 3 4 * * // This depends on the time we need to run the scheduler

image: repository: api-cronjob tag: v1

command:

python3
cronJobAPIConfig.py

args:

monthly // This is the job name which differs from the requirement of scheduler type.

env:

name: JOB_NAME

valueFrom:

fieldRef:

fieldPath:

resources: |

requests: {}

The remaining fields will be the same for all the schedulers.

Monthly: This will run and send the notification to the ULB employee or consumer on the 4th of every month morning at 9 am as per the scheduled time.

Fortnightevening: This scheduler will run on the 1st and 15th of every month evening at 6 pm to send the respective notification to the Consumer.

Failedbulkdemand: When the bulk demand generation is failed this scheduler will run and share the message to ULB employees to generate demand manually.

Dailyevening: This scheduler will run daily and send notifications to the collection operator on a daily basis.

Check the links below

MDMS object details and configuration:

{

"jobName": "monthly", // This will change based on the job name

"active": "true", // when the "active" param is set to true, the scheduler runs automatically. The scheduler does not run when set to false.

"method": "POST",

"url":", // This is the respective service URL to call that service as per the scheduler.

"payload": {

"RequestInfo": "{DEFAULT_REQUESTINFO}" // this is common in all the schedulers used to send the request info.

"header": {

"Content-Type": "application/json" // This is a common property for all schedulers.

}

Here is the configuration for all the schedulers:

User Creation

Need to create a user with CRONJOB as name and type as SYSTEM and ROLE as SYSTEM AND EMPLOYEE here is the sample curl to create the user.

Deployment

A Build ID (similar to the id given below) is created when you build the cronjob. api-cronjob:develop-c0aa08a-2

Take the id only from this instead of a complete name like develop-c0aa08a-2. This id will be used as the id for your respective yaml files and the same will be deployed to the required environment to test the cron job.

For example:

Mdms-read-cronjob:develop-c0aa08a-2,

failedbulkdemand:develop-c0aa08a-2,

Fortnightevening:develop-c0aa08a-2,

monthly:develop-c0aa08a-2 Note: develop-c0aa08a-2 is the common build id for all the files which you are using.

How to run the cronjob manually

Delete the existing cron jobs if they already exist with the same name.

kubectl delete cronjob mdms-read-cronjob -n mgramseva

Deploy these builds in QA environments, which are related to cronjob schedulers.

mdms-read-cronjob:develop-c0aa08a-2, failedbulkdemand:develop-c0aa08a-2, fortnightevening:develop-c0aa08a-2,monthly:develop-c0aa08a-2

Steps to test the cron job scheduler.

kubectl get cronjob -n mgramseva -- to check the list of cron jobs

Create the job manually to test the messages.

Here are the commands to create the jobs.

A message is received for the respective schedulers each time we run it.

We can increase the number to test again like failedbulkdemand-manually-1 next it will be failedbulkdemand-manually-2.

kubectl create job --from=cronjob/failedbulkdemand failedbulkdemand-manually-1 -n mgramseva
kubectl create job --from=cronjob/fortnightevening fortnightevening-manually-1 -n mgramseva
kubectl create job --from=cronjob/mdms-read-cronjob mdms-read-cronjob-manually-1 -n mgramseva
kubectl create job --from=cronjob/monthly monthly-manually-1 -n mgramseva

To check the cronjob image

kubectl describe cronjob mdms-read-cronjob -n mgramseva

To delete specific job

kubectl delete jobs mdms-read-cronjob-manually-1 -n mgramseva

All content on this page by is licensed under a .

curl --location --request POST 'http://localhost:8090/ws-services/wc/_create' \
--header 'authority: mgramseva-qa.egov.org.in' \
--header 'accept: */*' \
--header 'accept-language: en-GB,en-US;q=0.9,en;q=0.8' \
--header 'content-type: application/json; charset=utf-8' \
--header 'cookie: _ga_MY9HZBBBC8=GS1.1.1646915127.24.1.1646915152.0; _ga=GA1.1.1108799280.1643257024; _ga_8H6W5DYGX0=GS1.1.1655294682.124.0.1655294682.0' \
--header 'origin: https://mgramseva-qa.egov.org.in' \
--header 'referer: https://mgramseva-qa.egov.org.in/mgramseva/home/consumercreate' \
--header 'sec-ch-ua: " Not A;Brand";v="99", "Chromium";v="102", "Google Chrome";v="102"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "Linux"' \
--header 'sec-fetch-dest: empty' \
--header 'sec-fetch-mode: cors' \
--header 'sec-fetch-site: same-origin' \
--header 'user-agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.61 Safari/537.36' \
--data-raw '{
    "RequestInfo": {
        "apiId": "mgramseva",
        "ver": 1,
        "ts": "",
        "action": "_create",
        "did": 1,
        "key": "",
        "msgId": "20170310130900|en_IN",
        "authToken": "cded20ed-d1f7-40ca-bd8e-978e319fdcea",
        "userInfo": {
            "id": 705,
            "uuid": "36b747f4-bd94-4be7-b0cc-e59af2ff970b",
            "userName": "8122091926",
            "name": "Vasanthi",
            "mobileNumber": "8122091926",
            "emailId": "[email protected]",
            "locale": null,
            "type": "EMPLOYEE",
            "roles": [
                {
                    "name": "GP Admin",
                    "code": "GP_ADMIN",
                    "tenantId": "pb.lodhipur"
                },
                {
                    "name": "Bulk Demand Processing",
                    "code": "BULK_DEMAND_PROCESSING",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Super User",
                    "code": "SUPERUSER",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Profile update",
                    "code": "PROFILE_UPDATE",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "Dashbaord Viewer",
                    "code": "DASHBOARD_VIEWER",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Expense Processing",
                    "code": "EXPENSE_PROCESSING",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Dashbaord Viewer",
                    "code": "DASHBOARD_VIEWER",
                    "tenantId": "pb.lodhipur"
                },
                {
                    "name": "Expense Processing",
                    "code": "EXPENSE_PROCESSING",
                    "tenantId": "pb.lodhipur"
                },
                {
                    "name": "GP Admin",
                    "code": "GP_ADMIN",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "GP Admin",
                    "code": "GP_ADMIN",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Profile update",
                    "code": "PROFILE_UPDATE",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "Bulk Demand Processing",
                    "code": "BULK_DEMAND_PROCESSING",
                    "tenantId": "pb.lodhipur"
                },
                {
                    "name": "Profile update",
                    "code": "PROFILE_UPDATE",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Profile update",
                    "code": "PROFILE_UPDATE",
                    "tenantId": "pb.lodhipur"
                },
                {
                    "name": "Employee",
                    "code": "EMPLOYEE",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Employee",
                    "code": "EMPLOYEE",
                    "tenantId": "pb.lodhipur"
                },
                {
                    "name": "Collection Operator",
                    "code": "COLLECTION_OPERATOR",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Employee",
                    "code": "EMPLOYEE",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "Bulk Demand Processing",
                    "code": "BULK_DEMAND_PROCESSING",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Bulk Demand Processing",
                    "code": "BULK_DEMAND_PROCESSING",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "Collection Operator",
                    "code": "COLLECTION_OPERATOR",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "Employee",
                    "code": "EMPLOYEE",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "Dashbaord Viewer",
                    "code": "DASHBOARD_VIEWER",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "Super User",
                    "code": "SUPERUSER",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Dashbaord Viewer",
                    "code": "DASHBOARD_VIEWER",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "Expense Processing",
                    "code": "EXPENSE_PROCESSING",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Expense Processing",
                    "code": "EXPENSE_PROCESSING",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "Dashbaord Viewer",
                    "code": "DASHBOARD_VIEWER",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Bulk Demand Processing",
                    "code": "BULK_DEMAND_PROCESSING",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "GP Admin",
                    "code": "GP_ADMIN",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Super User",
                    "code": "SUPERUSER",
                    "tenantId": "pb.lodhipur"
                },
                {
                    "name": "GP Admin",
                    "code": "GP_ADMIN",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "Expense Processing",
                    "code": "EXPENSE_PROCESSING",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "Collection Operator",
                    "code": "COLLECTION_OPERATOR",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "Profile update",
                    "code": "PROFILE_UPDATE",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Super User",
                    "code": "SUPERUSER",
                    "tenantId": "pb.massewal"
                },
                {
                    "name": "Employee",
                    "code": "EMPLOYEE",
                    "tenantId": "pb.dabourlower"
                },
                {
                    "name": "Super User",
                    "code": "SUPERUSER",
                    "tenantId": "pb.lalpur"
                },
                {
                    "name": "Collection Operator",
                    "code": "COLLECTION_OPERATOR",
                    "tenantId": "pb.dabourupper"
                },
                {
                    "name": "Collection Operator",
                    "code": "COLLECTION_OPERATOR",
                    "tenantId": "pb.lodhipur"
                }
            ],
            "active": true,
            "tenantId": "pb",
            "permanentCity": null
        }
    },
    "WaterConnection": {
        "id": null,
        "connectionNo": null,
        "propertyId": "PB-PT-2022-06-15-1722",
        "applicationNo": null,
        "tenantId": "pb.lodhipur",
        "action": "SUBMIT",
        "status": null,
        "meterInstallationDate": 1651343400000,
        "documents": null,
        "proposedTaps": 1,
        "noOfTaps": 1,
        "paymentType":"arrears",
        "arrears": 112,
        "penalty":50,
        "connectionType": "Metered",
        "oldConnectionNo": "",
        "meterId": "121212",
        "propertyType": "RESIDENTIAL",
        "previousReadingDate": 1651343400000,
        "previousReading": 56,
        "proposedPipeSize": 10,
        "connectionHolders": [
            {
                "id": null,
                "uuid": null,
                "userName": null,
                "password": null,
                "aadhaarNumber": null,
                "permanentAddress": null,
                "permanentCity": null,
                "permanentPinCode": null,
                "correspondenceCity": null,
                "correspondencePinCode": null,
                "correspondenceAddress": null,
                "pwdExpiryDate": null,
                "accountLocked": null,
                "active": null,
                "type": null,
                "tenantId": null,
                "altContactNumber": null,
                "ownerInfoUuid": null,
                "isPrimaryOwner": null,
                "ownerShipPercentage": null,
                "institutionId": null,
                "designation": null,
                "emailId": null,
                "isCorrespondenceAddress": null,
                "mobileNumber": "9182541372",
                "fatherOrHusbandName": "Sravan",
                "name": "Sravani",
                "status": null,
                "gender": "FEMALE",
                "ownerType": "NONE",
                "documents": null,
                "roles": null
            }
        ],
        "additionalDetails": {
            "initialMeterReading": 56,
            "meterReading": 56,
            "locality": "WARD1",
            "category": null,
            "subCategory": null,
            "aadharNumber": null,
            "propertyType": "RESIDENTIAL",
            "street": "",
            "doorNo": "",
            "collectionAmount": null,
            "collectionPendingAmount": null,
            "action": null
        },
        "processInstance": {
            "action": "SUBMIT"
        }
    }
}'

mGramSeva Dashboard

Overview

DSS has two sides to it. One is, the process in which the Data is pooled to 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 mGramSeva.

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 mGramseva in this dashboard-analytics.

Dashboard analytics link -

Below is a list of configurations that need to be changed to run mGramSeva successfully.

Chart API Configuration
Master Dashboard 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 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 mGramSeva.

Master Dashboard Configuration

Master Dashboard Configuration is the main configuration that defines as to which are the Dashboards that are to be painted on the 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.

Role Dashboard Mappings Configuration

Master Dashboard Configuration which was explained earlier hold the list of Dashboards that 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.

Transform collection schema for V2
- This transform collection v1 configuration file is used to map with the incoming data. This mapped data will go inside the data object in the DSS collection v2 index.

Here: $i, the variable value that gets incremented for the number of records of paymentDetails $j, the variable value that gets incremented for the number of records of billDetails.
This configuration defines and directs the Enrichment Process which the data goes through.
For example, if the Data which is incoming is belonging to a Collection Module data, then the Collection Domain Config is picked. And based on the Business Type specified in the data, the right config is picked.

Enrichment Domain Configuration

Domain configuration
Topic context configuration
transform_expense.electricity_bill_v1 configuration
transform_expense.om_v1 configuration

Below are the list of configurations made changes or added newly for mGramSeva.

Topic Context Configuration

Topic Context Configuration is an outline to define which data is received on which Kafka Topic.
Indexer Service and many other services are sending out data on different Kafka Topics. If the Ingest Service is asked to receive those data and pass it through the pipeline, the context and the version of the data being received has to be set. This configuration is used to identify as in which Kafka topic consumed the data and what is the mapping for that.

Based on expense and water-service business service we added transform configurations as per below.

transform_expense.electricity_bill_v1 configuration:

transform_expense.om_v1 configuration:

transform_expense.salary_v1 configuration:

transform_ws_v1 configuration:

Note: For Kafka connect to work, Ingest pipeline application properties or in environments direct push must be disabled.

es.push.direct=false
If DSS collection index data is indexing directly ( without Kafka connector) to ES through the ingest pipeline then, make the application properties or in environments, direct push must be enabled.
es.push.direct=true

Creating Kafka Sync Connector - push the data to the Elasticsearch

Configure the Kafka topics in the environments or Ingest pipeline application properties as shown below.

Kafka connection and re-indexing is available in this documentation. Please check from here.

Dashboard Service Changes

Main-Monthly Dashboard

For the main monthly dashboard, we are using the service API to fetch the data and to show it in the main monthly dashboard table.

Ws-services:

/ws-services/wc/_revenueCollectionData Should be added to get the main monthly dashboard details. It is used to show the table data based on the no of months for selected financial year.

eChallan-Service:

/echallan-services/eChallan/v1/_chalanCollectionData it is added to get the main monthly dashboard data for the expense.

Dashboard-Metrix:

To show the data in metrix format in specific month dashboard we are using service API which will fetch the data based on dash board type.

Ws-services:

/ws-services/wc/_revenueDashboard Should be added to get the revenue dashboard metrix data. It will show the data of revenue collections information

eChallan-Service:

/echallan-services/eChallan/v1/_expenseDashboard Is added in echallan-service to show the data of expenses in metrix format.

MDMS- changes for the dashboard:

Actions & Role Action Mapping

Actions

Role Action Mapping

Available Roles

Postman-collection for these dashboards

All content on this page by is licensed under a .

Property Services

Overview

One of the major applications of the eGov stack is that it helps municipalities and citizens handle property tax payments and other related functions on the property such as assessments, mutation, and so on.

Pre-requisites

Prior knowledge of Java/J2EE
Prior knowledge of Spring Boot
Prior knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.
Prior knowledge of Git

Key Functionalities

The Property Service provides multiple functionalities starting from serving as a central repository where property information is registered for reference of citizens and other municipality-provided services such as water connection and sewerage management. An assessment can be done to calculate and pay tax on the property. The different services provided by the property services are -

Property Registry
Assessment
Mutation
Bifurcation

Registry Explanation

The registry flow helps the citizen/Employee to create a property in the system with the minimal information required.
Other workflows such as assessment or mutation can be triggered on the existing ACTIVE Property in the registry.
The property can be created, updated, cancelled, and searched followed by the process of Mutation and Assessment.

Configuration Details

MDMS CONFIG:

Persister File Configuration

The persister file configuration for property services can be found in the Config repo of eGov Git, which needs to be added in the persister service -

Workflow Configurations

Each flow in the property has a workflow associated with it, which can be controlled by following configurations.

The Boolean field can enable/disable Workflow - the same field controls the update and creates the workflow.

name

value

description

Workflow configuration for a property is created if the source is from the WATER CONNECTION module.

For the creation of property from the water and sewerage module, as per the use case mentioned in this , a different workflow configuration is used. For each use case, to identify which workflow to use can be identified from this .

Use Case 1, which involves property creation from the Water and Sewerage module, necessitates a single-step workflow. In the MDMS file mentioned above, ensure that the businessService with PT.CREATEWITHWNS object is enabled, allowing the field to be set as true. Property creation from the Water and Sewerage module will feature a one-step workflow, for properties in an ACTIVE state.

Fields in the above MDMS file:

MDMS Fields

Description

Note: Each object mentioned above represents a specific use case outlined in this ticket. Therefore, only one object (use case) enable field should be set to true at any given time.

Sample workflow config for use case 1 where property creation is from water and sewerage module with one-step workflow

Sample workflow config - (The same PT.CREATE can be used for update workflow also since both involve the same functionality)

PT.LEGACY workflow config

Notifications :

To enable or disable notifications notif.sms.enabled=true

#notif urls - makes use of the UI app host in notification service egov.notif.commonpay = citizen/egov-common/pay?consumerCode={CONSUMERCODE}&tenantId={TENANTID} egov.notif.view.property = citizen/property-tax/my-properties/property/{PROPERTYID}/{TENANTID} egov.notif.view.mutation = citizen/pt-mutation/search-preview?applicationNumber={APPID}&tenantId={TENANTID}

The current localization messages for notification -

Configs in App.props

name

value

Integration Details

Integration Scope

Property service can be integrated with any organization or system that wants to maintain a record of the property and collect taxes with ease.

Integration Benefits

Easy to create and simple process of self-assessment to avoid the hassle.
Helps maintain property data which can be used in the integration of other essential services like asset management, water connection and so on.
provides additional functionalities like mutation and assessment of properties.

Integration Steps

Customers can create a property using the /property/_create
Search the property using /property/_searchendpoint
/property/_update endpoint to update the property demand as needed.
Mutation can be carried out with the help of /property/_update itself, no extra API is required.

Reference Docs

Doc Links

API LIST

mGramSeva - Water Services

Overview

Water service is a DIGIT application that helps and gives flexibility to municipalities and citizens to manage water service requirements like applying for a water connection or searching for water connections. The application goes through various steps as defined by the states. The application is passed through different users who verify and inspect the application details before moving it to the next stage. Based on the state, citizens get notifications (SMS and in-app ). Citizens can also pay application fees or employees can collect the fee for the application.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

Java 8
Kafka server is up and running
egov-persister service is running and has a water service persister config path added to it
PSQL server is running and a database is created to store water connection/application data

Key Functionalities

Add old water connection to the system with/without arrears
Create a new Water Connection
Searching for water connections
Notification based on the application state

Interaction Diagram

Configuration Details

MDMS configuration

master-config.json for water service

ConnectionType

Two connection types supported Metered and Non metered.

CheckList

A CheckList is used to define the Q & A for the feedback form and its validation.

Category

Predefined list of categories allowed.

SubCategory

A pre-defined list of subcategories is allowed.

Property creation through WNS module

Persister configuration

Actions & Role Action Mapping

Actions

Role Action Mapping

Roles available

Workflow business service config:

Create businessService (workflow configuration) using the /businessservice/_create. Following is the product configuration for water service:

Indexer config for water service:

The indexer provides the facility for indexing the data to elastic search.

Setup

Write the configuration for water service.
Provide the absolute path of the checked-in file to DevOps, to add it to the file-read path of egov-indexer. The file will be added to the egov-indexer's environment manifest file for it to be read at the start-up of the application.
Put indexer config file to the config repo under egov-indexer folder.( )

Notification

Notification will be sent to the property owners and connection holders based on different application states.

Capturing Connection Holders

We can add connection holders to the water connection which will be the owner of the connection. We can fill in the connection holders' details or we can just make the property owner to the connection holder.

The connection holder will get a notification based on a different state of the application. We are pushing the data of the connection holders in the user service too.

Multiple Road Type Support

We can add road cutting details of multiple roads to the water connection. For each road that goes undercutting process, we have to fill their road type details and road cutting area. Based on this information, the application one-time fee estimate is calculated.

Deployment Details

Add mdms configs required for water connection registration and restart mdms service.
Deploy the latest version of ws-services service.
Add water-service and water-services-meter persister yaml path in persister configuration and restart persister service.
Add Role-Action mapping for API’s.

Integration

Integration Scope

This ws-service module is used to manage water service connections against a property in the system.

Integration Benefits

Provide backend support for the different water connection registration processes.
Mseva and SMS notifications on application status changes.
The elastic search index for creating visualizations and Dashboards.
Supports workflow which is configurable

Steps to Integration

To integrate, the host of ws-service module should be overwritten in helm chart.
/ws-services/wc/_create should be added as the create endpoint for creating water application/connection in the system.
/ws-services/wc/_search should be added as the search endpoint . This method handles all requests to search existing records depending on different search criteria.

Reference Docs

Doc Links

API List

(Note: All the API’s are in the same postman collection therefore the same link is added in each row)

All content on this page by is licensed under a .

v1.2

Introducing mGramSeva

About mGramSeva

Problems Addressed

Approach

Features

Section Overview

Contact Us

Platform

Release Notes

Release Summary

New ‌Feature Additions/Enhancements

Road Map

Other Enhancements

Success Metrics

Known Issues

Document Resources & Links

Web Caching

Package Used

Test Cases

Architecture

Service Architecture

Demo video

Configure mGramSeva

Technical User Docs

Application Structure

Firebase Analytics Integration

About Firebase Analytics

Integration Testing

About Integration Testing

Plugins Used

Integration Test Setup

Integration Test Run

File Path

Reference Links

Backend Services

iFix Adapter Integration Service

Objective

Overview

Tech User Manual

Home Page

Overview

Consumer Details

Expenses

Dashboards

Consumer Feedback

Overview

mGramSeva UI

UI Mockups

mGramSeva UI

Enablement toolkits

AWS Installation

Setup AWS Account

Certificate Purchase

Setup Git Repository

Overview

Steps

Create Git Account In The Client Name

Overview

Steps

Setting up Services

Loading Consumers For mGramSeva

Overview

Steps

Product Docs

Functional Docs

Login & Forgot Password

Overview

Language Selection

User ID and Password Entry

Forgot Password

On Successful Login or on Validations of User ID and Password

First Time Login

Subsequent Login

Billing - Bulk Demand Generation

Platform

Test Cases

Web Caching

Package Used

Demo video