DIGIT Docs
  • DIGIT Knowledge Base
  • Local Governance
  • Introducing NalJalSeva
  • 🚰NalJal
    • Approach
    • Demo Video
    • Value Proposition
  • 🌊Product Specifications
    • Features & Functions
    • Workflows
      • Login & Forgot Password
      • View Consumer
      • Update Consumer
      • Water Charges
      • Generate Bulk Demand & Raise Bills
      • Generate Bills For Metered Connections
      • Collect Revenue Offline
      • Add Expense
      • Update Expense
      • Send SMS Notifications
      • Edit User Profile
      • View Household Register
      • View Tabular Dashboard For Expense
      • Download Bills & Receipts
      • View & Download Reports
      • HRMS
        • Login, Reset & Forgot Password
        • Create Employee
        • Update Employee
        • Search Employee
        • Search Department Employee
        • Edit Scheme Rate Master
        • Edit Penalty Master
        • State Dashboard
        • Rollout Dashboard
        • Rate Dashboard
    • User Manual
      • Common Functions
        • Login To App
        • Edit Profile & Change Password
      • Division User
        • View & Edit Consumer
      • Village Water & Sanitation Committee (VWSC) User
        • Generate Bills
        • Search Consumer & Generate Payment
        • Record & Modify Expense Bill
        • View Dashboards
      • State User
  • Reference Implementations
    • Punjab
      • mGramSeva
  • ⚒️NalJalSeva Platform
    • Architecture
    • Technology
  • 💧Setup NalJalSeva
    • Setup NalJalSeva
      • Install AWS
        • Setup AWS Account
        • Purchase Certificate
        • Setup Git Repository
        • Configure Domain Name
        • Create Git Account In The Client Name
      • Enable Application Permissions
      • Get Started With DIGIT
      • Create Users
      • Load Employees For NalJalSeva
      • Load Consumers For NalJalSeva
      • Configure Module Localisation
      • Update Master Rate
      • Create Consumer API
      • Create User API
      • Configure SMS Template
      • Configure Master Data Management System
      • Create New Tenant
      • Create Workflow
    • Configure NalJalSeva
      • Configure Core Services
      • Configure Backend Services
        • Advance Changes
        • Apportion
        • Billing
        • Dashboard
        • eChallan
        • iFIX Adapter
          • Push Events To iFIX Adapter
        • Penalty Changes
        • Property
        • Reindexing
        • Rollout Dashboard
        • Scheduler
        • User
        • User OTP
        • User Events
        • Vendor Registry
        • Water
        • Water Calculator
      • Configure UI Screens
        • UI Design
        • Select Language
        • Login
        • Change Password
        • Edit Profile
        • Home Page
        • Forgot Password
        • Update Password
        • Generate Bill
        • Search Connection
        • Consumer Screens
          • Create Consumer
          • Update Consumer
        • Expense Screens
          • Add Expense
          • Search Expense Bills
          • Modify Expenses
        • Dashboards Screens
          • Monthly Dashboard
          • Collections Dashboard
          • Expenditure Dashboard
        • Collect Payment
        • Consumer Feedback
        • Household Register
        • UI Mockup Screens
      • Update App
    • Integration Details
      • Integrate Firebase Analytics
      • Integrate Bluetooth Thermal Printer
      • Integration Testing
      • Integration Testing With Github Actions
    • Go Live
Powered by GitBook

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

On this page
  • File Path
  • API Details
  • Process Details
  • Advance and Penalty
  • Role Access Mapping
  • File Path

Was this helpful?

Export as PDF
  1. Setup NalJalSeva
  2. Configure NalJalSeva
  3. Configure UI Screens
  4. Consumer Screens

Create Consumer

PreviousConsumer ScreensNextUpdate Consumer

Last updated 10 months ago

Was this helpful?

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 has the taxHeadMasterCode 10201, we show the Penalty placeholder 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'];

File Path

Model →

View →

Controller →

Components utilised from the Widgets Library

Components File Links

defined in

Water Connection Request JSON defined in

💧
TextField Builder
RadioButtonField Builder
SearchSelectField Builder
DatePicker Builder
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