DIGIT mGramSeva
PlatformDomainsAcademyDesign SystemFeedback
v1.2
v1.2
  • Introducing mGramSeva
    • Platform
      • Release Notes
        • Web Caching
        • Service Build Updates
        • MDMS Configuration & Migration Updates
        • Test Cases
        • Release Checklist
        • Implementation Checklist
      • Technology
      • Architecture
      • Demo video
      • Configure mGramSeva
        • Vendor Registry Service
        • User Events Service
        • eChallans Service
        • Water Calculator Service
        • Property Services
        • Billing Service
        • Apportion Service
      • Technical User Docs
        • Application Structure
        • Firebase Analytics Integration
        • Integration Testing
        • Integration Testing With Github Actions
        • Backend Services
          • 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
          • mGramSeva- Services Re-Indexing
          • mGramSeva Dashboard
          • Events Push To IFIX Adapter
        • Tech User Manual
          • Language Selection
          • Login
          • Change Password
          • Edit Profile
          • Home Page
          • Forgot Password
          • Update Password FTL
          • Generate Bill
          • Search Connection
          • Consumer Details
            • Create Consumer
            • Update Consumer
          • Expenses
            • Add Expenses
            • Search Expense Bills
            • Modify Expenses
          • Dashboards
            • Monthly Dashboard
            • Collections Dashboard
            • Expenditure Dashboard
          • Collect Payment
          • Consumer Feedback
          • Household Register
          • Bluetooth Thermal Printer Integration
        • Application Permissions & Dependencies
        • mGramSeva UI
          • UI Mockups
          • mGramSeva UI
            • mGramSeva - Advance Changes
            • mGramSeva Penalty Changes
      • Installation
      • Configuration
    • Enablement toolkits
      • AWS Installation
        • Setup AWS Account
        • Certificate Purchase
        • Setup Git Repository
        • Domain Name Configuration
        • Create Git Account In The Client Name
      • Setting up Services
        • 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
    • Product Docs
      • Functional Docs
        • Login & Forgot Password
        • User Roles & Home Screen
        • Create Consumer
        • Search Consumer
        • Edit Consumer
        • View Consumer
        • Billing - Bulk Demand Generation
        • Billing - Metered Connection
        • Revenue Collection - Offline
        • Expenditure - Add Expense
        • Expenditure - Modify Expense
        • User Onboarding - Bulk Upload
        • User Onboarding/Walkthrough
        • Feedback - Post Payment
        • SMS Notifications
        • Home Page Notifications
        • Edit User Profile
        • Bill and Receipt PDF
        • Update Expense Search
        • Bulk Demand Generation For Non-Metered Connection
        • Demand/Bill Generation For Metered Connection
        • Household Register
        • Tabular Dashboard - Expense
        • Tabular Dashboard - Collection
        • Download Bills & Receipt
        • App Force Update
        • HRMS
        • Advance Changes
      • User Docs
        • User Manual
  • 🚻Community
    • Roadmap
    • Source Code
    • Discussion
    • Events
    • Training & Certification
Powered by GitBook
On this page
  • Overview
  • File Path
  • API Details
  • Process Details
  • Logic Implemented For Advance
  • Logic Implemented For Time Penalty
  • Logic Implemented For First Demand Penalty
  • Role Access Mapping
  • Files Path
  1. Introducing mGramSeva
  2. Platform
  3. Technical User Docs
  4. Tech User Manual
  5. Consumer Details

Create Consumer

PreviousConsumer DetailsNextUpdate Consumer

Last updated 2 years ago

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

Overview

Enables employees to create new Consumers or Connections - The process of onboarding the end-users.

Link

→ {base url}/mgramseva/home/consumercreate

The Create Consumer card is available on the home screen as per the defined user role.

Click on the Consumer Create card navigates the user to the consumer creation screen.

Users enter the required details for the creation of a consumer.

If a user logs in for the first time then a walkthrough is populated following the same logic as in the home screen.

File Path

Primary Files - ,

Fields

Validations

consumer Name*

[A-Za-z ]

Gender*

None

Spouse/Parent’s Name*

[A-Za-z ]

Phone Number*

[0-9]

Old Connection No

None

Category

None

Sub Category

None

Door Number

None

Street Name/Number

None

Gram Panchayat Name*

None- Disabled

Propert Type*

None

Service Type*

None

Meter Id

[a-zA-Z0-9]

Meter Reading

[0-9]

Billing Cycle

None

Arrears

[0-9.]

Advance

[0-9.]

Penalty

[0-9.]

Note: All fields are validated on Submit except the Phone number which gets validated on change.

API Details

API
Params
Description

/egov-mdms-service/v1/_search

[{"moduleName":"ws-services-masters","masterDetails":[{"name":"connectionType"}]},{"moduleName":"PropertyTax","masterDetails":[{"name":"PropertyType"}]},{"moduleName":"BillingService","masterDetails":[{"name":"TaxPeriod","filter":"[?(@.service=='WS' && @.fromDate <= 1631989800000 && @.toDate >= 1631989800000)]

To get the Property Type and service Type and billing cycle values for the Dropdown

egov-location/location/v11/boundarys/_search?

hierarchyTypeCode=REVENUE&boundaryType=Locality&tenantId={tenantID}

To get the values for Locality DropDow

Process Details

Consumer creation involves 2 sequential processes

  1. Property Creation

  2. Water connection Creation

After creating a property, the Property ID is linked to the WaterConnection Request JSON.

Water connection creation is of two types:

A metered connection that requires Meter ID and meter installation Date/ Last Meter Reading Date and an optional field to capture meter reading.

Non-Metered Connection which requires the last billing cycle as mandatory params captured in the field as shown below.

Users can switch between connection types by selecting a desired value from the Service Type DropDown.

Advance and Penalty

  • For consumers, users can give either Advance or Arrears along with a Penalty by selecting the respective option using the radio buttons. If a user selects Advance, the field is shown or else Arrears and Penalty will be shown where the user can enter the required amount.

  • The radio button “Advance” will be displayed only if the config flag “Advance enabled” is activated in the MDMS billing service.

  • The “Penalty” field (displayed along with arrears) on selecting the Arrears radio button, will be displayed only if the config flag “Penalty enabled” is activated in the MDMS billing service. The user will be able to see the arrears field and can enter the arrears amount.

Logic Implemented For Advance

billing-service/demand/_search API is used for calculating the advance amount for the current bill. We can get the advance amount if taxHeadMasterCode contains 'WS_ADVANCE_CARRYFORWARD'. Here we have 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 how much we utilised from the total advance amount. We can get the current advance from the taxAmount - collectionAmount

Logic Implemented For Time Penalty

billing-service/demand/_search API is used to calculate the Penalty amount. We can get the penalty amount if taxHeadMasterCode contains 'WS_TIME_ADHOC_PENALTY'. We get the penalty amount from the tax amount property.

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

Logic Implemented For First Demand Penalty

If it is the first demand and it is having the taxHeadMasterCode 10201, we show the Penalty place holder in the bill details.

API
Description

property-services/property/_create

Property Creation Request JSON

ws-services/wc/_create

Role Access Mapping

    case Routes.CONSUMER_CREATE:
        return ['GP_ADMIN', 'SUPERUSER'];

Files Path

Components utilised from Widgets Library

Components

File Path

TextField Builder

RadioButtonField Builder

SearchSelectField Builder

DatePicker Builder

defined in

Water Connection Request JSON defined in

Model → ,

View →

Controller → ,

https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/widgets/TextFieldBuilder.dart
https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/widgets/RadioButtonFieldBuilder.dart
https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/widgets/SearchSelectFieldBuilder.dart
https://github.com/misdwss/punjab-mgramseva/blob/master/frontend/mgramseva/lib/widgets/DatePickerFieldBuilder.dart
punjab-mgramseva/WalkFlowContainer.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/walkthrough.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/property.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/water_connection.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/ConsumerDetails.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/consumer_details_repo.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/consumer_details_provider.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/property.dart at develop · egovernments/punjab-mgramseva
punjab-mgramseva/water_connection.dart at develop · egovernments/punjab-mgramseva