Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Apply for trade license, ensure compliance with trade safety guidelines, and lots more
DIGIT-Trade Licence (TL) enables local government bodies to regulate trading establishments. It also serves to protect the interest of the public at large against possible health hazards and inconveniences that can be caused by any business operations. With DIGIT-TL traders can obtain the trade certificate in a simplified manner and ensure compliance with rules and safety guidelines issued by the government. The module offers the citizens and governance bodies a convenient and transparent means of processing trade licenses.
The Trade Licence application makes the process of obtaining a Trade Licence easy, smooth, and transparent. The module, hence, removes the need for manual processing and streamlines the key trade licence management functions to provide a better user experience.
DIGIT Trade Licence module enables citizens to -
Apply for a new trade licence or renew an existing trade licence.
Upload all the relevant documents required for the licence.
Make payment for the Trade Licence (New/Renewal) fee using the online payment gateway.
Receive notifications and alerts by emails or SMS for new application status updates and pending renewals.
Download Trade Licence, Payment & Acknowledgement Receipts online.
DIGIT Trade Licence module enables employees to -
Create flexible role-based workflows.
Configure license fees calculation logic.
View custom dashboards for module statistics.
Filter search results using advanced configurable search parameters.
This section contains all docs and information required to understand the TL module, its key features, functional scope, and configuration details. Click on the links below to learn more about deploying, configuring, customizing, and using the TL module.
TL Roadmap
TL Workflows
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
Find the list of Related Docs links at the bottom of each page to browse through additional product details
Reach out to us through any of the below-mentioned contact channels for any assistance or additional information on TL module deployment.
#147/J, 1st floor, 10th Cross, 12th Main, 3rd Block, Koramangala, Bangalore 560034
For traders to do business in India, ease in redundant procedures and regulatory processes is of paramount importance. DIGIT-Trade License increases procedural efficiency, improves access to license information, and provides transparency thus enabling the business to flourish and function with ease.
Functional overview for stakeholders
The Trade License product provides a digital interface, allowing citizens to apply for the Trade License and subsequently make the trade license fee payment online.
The Trade License product enables:
Ease of doing business — Traders can apply for new licenses, renewals, amendments, and supplemental licenses
Regulatory Tracking — Administrators can track and manage regulatory processes
Shorter Timelines — It streamlines and automates business licensing processes and helps a business to be set up quickly
Data-driven decision making — The application collates valuable information on the economic activity and employment opportunities in a ULB
The list below summarizes the key features supported by the TL module -
Registration, Login and Creation of User Profile
Applying for a Trade License
Trade License Issue
Modifications to a Trade License
Renewal of Trade License
Payments and Fee
Dashboards and Reports
General Features
Key capabilities offered by this functional component -
OTP Based Login for Citizen via Web/Mobile App
OTP Based Login for Employee via Web/Mobile App
Provision for language selection during first time registration for both Employee and citizens
Provision of creating a personalized Profile for Citizens and employees on Web App
Login Credentials for the various hierarchies of employees
Role-based access for performing different actions relating to Trade License modules
User can apply for a new TL from the system. User can select the type of license to apply. The user enters trade details, owner details and documents after which application can be reviewed and submitted. Similarly, a counter employee can also apply for TL on behalf of the citizen. The system has a workflow integration which enables stage-wise approval before Approval for issuing the Trade License.
Key capabilities offered by this functional component -
Citizen can Apply for a new Trade License through mobile app/ Web
Citizen/CSC can capture Trade details, Trade Units, Accessories, Owner Details, Address, purpose, Date of issuance, License number etc.
Citizen/CSC Upload Documents
Citizen/CSC can calculate Breakup Based on Selected Trade
Citizen/CSC can select Multiple Accessories for the Trade
Citizen/CSC can Apply for Multiple Trade Licenses
Citizen/CSC can Download/Print Application Summary
Citizen/CSC can Download/Print Trade Reference No
Citizen/CSC can View the applied licenses
The system has the facility to deliver the service online & through SEWA KENDRA.
The portal displays all the information including the processes and documents required for the convenience of the citizen.
The system has the facility to assign a unique identification number based on the license type, which will be used for all future transactions of the license.
The system has the facility to assign the application to the respective Inspector for survey and verification. After the application is submitted, it goes to the document verifier. The next step after document verification is field inspection. After the field inspector’s approval, the TL is approved by the approver.
Key capabilities offered by this functional component -
Document Verifier, Verifies & Forwards or Rejects the application
Licensing Inspector, Verifies and Forward the Application
Licensing Inspector, Sends Back or Rejects the Application
Licensing Inspectors Approves the Application
Citizen, Pays for the license post verification process online or at the CSC
CSC, Collects Fee post verification.
The system allows the printing of license and sending the license through e-mail.
The system allows the SMS alerts to the applicant regarding the date of inspection/visit by the inspector, approval/rejection of the application.
The system allows the inspector to enter the field visit details and a field visit report is generated and automatically routed to the superintendent.
The system has the facility to edit/update the Application based on the Inspection report against the application.
The system has the facility to provide a hassle-free renewal process for citizen and employee ease, leading to increased revenues, by reducing unlicensed trades. The system allows sending of SMS and Email notifications and reminders based on the renewal cycle.
Key capabilities offered by this functional component -
The citizen can pay for the license post verification process
CSC, Collects Fee post verification.
The system allows intimating the applicant about the payment of the license fee through SMS/ e-Mail.
The system allows the Generation of receipt for the payment
The payment modes enabled are Card(offline), cash, cheque, DD
Following reports offered by the module -
Cancelled Receipt Register Report
TL Collection
TL Application Status- showing the number of licenses approved/rejected.
TL ULB Wise Status
State Dashboard: View Reports for Total Licenses, Licenses Issued, Payment Collected, Payment Distribution
Notifications - The system has the capability to send notifications to citizens. These notifications can be sent for various steps like - verification completion, payment reminder, payment confirmation. These notifications can be sent in the language chosen by the ULB through all channels - SMS, Whatsapp, Email.
Configurable Masters - The system provides the following masters that can be configured as per the State’s requirements:
Charges & Calculation : Calculation Engine, Rebate, Penalty,
Rate Master
State Masters: Trade Ontology, Documents List, Accessories, Ownership, Employee Data Mapping, Boundary Data Mapping, Fee Matrix (License Fees)
System specification in compliance with the Ease of Doing Business (EODB) BRAP 2019
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by is licensed under a .
List of Functionalities | Corresponding Features |
---|
All content on this page by is licensed under a .
Reform No. | Reform Area | Weightage (score) | Recommendation | Remarks |
80 | Sector Specific | 2 | Implement an online application system with the following features: i. Online submission of application without the need to submit physical copy of application ii. Eliminate physical touchpoint for document submission iii. Allow option of online payment of application fee iv. Allow applicant to track status of application online v. Applicant can download the final certificate online | Already available in the system |
Registration, Login, Creation of User Profile | Provision for Language Selection during first-time registration via Mobile/ Web App. |
OTP Based Login for Citizen/ Employee via Mobile/ Web App |
Login Credentials for the various hierarchy of employees |
Provision of Personalized Profile for Citizen/ Employee on Web App |
Applying for a Trade License | Citizen/CSC: Enters Trade Details, Trade Units, Accessories, Owner Details. |
Citizen/CSC: Upload Documents |
Citizen/CSC: ULB Wise Trade Selection |
Citizen/CSC: Calculation Breakup Based on Selected Trade |
Citizen/CSC: Multiple Accessories Field Count |
Citizen/CSC: Multiple Trade License. |
Citizen/CSC: Download/Print Application Summary |
Citizen/CSC: Download/PRINT Trade Reference No |
Citizen/CSC: View the applied licenses. |
Citizen: Pays for the license post verification process. |
CSC: Collects Fee post verification. |
Trade Licence Issue | Document Verifier : Verify & Forward/ Reject the application |
Licensing Inspector: Verify and Forward/ Send back/ Reject the Application. |
Licensing Officer: Approve/ Send back the Application |
Licensing Officer: Reject/ Cancel the Application |
Modification to a Trade License | Edit/ Update the Application based on the Inspection report against the application. |
Renewal of a Trade Licence | Renew trade license. |
Payment and Fee | Configurable Workflow Rights : Edit & Payment Collection |
Payments & Collection : Various Payment Modes |
Dashboards and reports | Cancelled Receipt Register Report |
TL Collection |
TL Application Status- showing the number of licenses approved/rejected. |
TL ULB Wise Status |
State Dashboard: View Reports for Total Licenses, Licenses Issued, Payment Collected, Payment Distribution |
General features | Notifications : SMS Notifications |
Charges & Calculation : Calculation Engine |
Charges & Calculation : Rebate/ Penalty- Date Based |
Charges & Calculation : Ad-Hoc Rebate/ Penalty |
Charges & Calculation : Exemptions Trade Type & Owner Type |
Configuration masters | Configurable Workflow Rights : Edit & Payment Collection |
Configurable Verification & Approval |
This section contains DIGIT product and module related documents
DIGIT offers several modules. Each module is designed to automate the manual workflows for various governance units.
DIGIT enables ULBs to be more effective and accountable—and to make better, data-driven decisions. The platform ensures both interoperability among ULBs and rapid development of new modules by a wide array of software partners.
Click on the individual product links to explore the functional details.
Click on the respective link below to learn more about that product, its features, applications and configuration details.
Faecal Sludge Management
This page provides configuration details for TL master data templates
The DIGIT-Trade License application makes the process of obtaining a Trade License easy, smooth, and transparent. The module, hence, removes the need for manual processing and streamlines the key trade license management functions to provide a better user experience.
DIGIT Trade License module enables citizens to -
Apply for a new trade license or renew an existing trade license.
Upload all the relevant documents required for the license.
Make payment for the Trade License (New/Renewal) fee using the online payment gateway.
Receive notifications and alerts by emails or SMS for new application status updates and pending renewals.
Download Trade License, Payment & Acknowledgement Receipts online.
DIGIT Trade License module enables employees to -
Create flexible role-based workflows.
Configure license fees calculation logic.
View custom dashboards for module statistics.
Filter search results using advanced configurable search parameters.
Receipt Register
Application Status
Cancelled Receipt Register
ULBwise Collection Report
ULBwise Application Status
Define Trade Types
Map Trade Category to listed Trade Types
The Trade Type can be defined as the next (2nd) level classification of Trade. There can be multiple trade types and the list may vary from one State/ULB to another.
The table above contains sample Trade Type data.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Select the relevant Trade Category Code from the available drop-down list of Trade Category. This will map the listed Trade Type to the corresponding Trade Category.
Enter a unique Trade Type Code to identify the type of trade.
Enter a Trade Type Name (In English).
Enter the Trade Type Name (In Local Language).
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
For the offered product, the implementation process can be divided into seven major distinctive stages. Each stage has predefined entry and exit criteria, roles & responsibilities to assure objective monitoring and decision-making for the overall success of the engagement. The whole implementation lifecycle is typical of 38-42 weeks for the State, keeping in mind the entry and exit criteria defined at the beginning and end of each stage are met on time recommended.
Exhibit 1: Phases of Implementation.
Stage Zero is that of program setup and onboarding which is a pre-requisite for the initiative to kick-off and requires setup of the governance model, implementation Team and decision regarding other significant elements of the initiative like funding and procurement process.
Stage One requires scoping of the initiative and decisions on the priorities for implementation by the State Implementation Team.
Stage Two - the State Team works on identifying and finding solutions to the significant gaps in the product offered with respect to the need of the State. Stage Three - involves the Configuration and customization of the product offered. This involves working on various aspects of State-specific needs and incorporating them into the product offered.
Implementation of the Trade License (TL) module requires meticulous planning and close coordination between various stakeholders at the centre and State levels. The success of the initiative is dependent upon many factors like strong Program governance, availability of trained resources, financial planning, targeted Implementation Team onboarding, focus on last-mile capacity building and ensuring necessary support to the Urban centre. Achievement of all these factors will provide the most effective and efficient roll-out and adoption of the Trade License System in the State.
The purpose of this document is to give an overview of the Trade License System (TLS). The Trade License product provides a digital interface, allowing citizens to apply for the Trade License and subsequently make the payment online.
The Trade License product enables:
Ease of doing business — Traders can apply for new licenses, renewals, amendments, and supplemental licenses
Regulatory Tracking — Administrators can track and manage regulatory processes
Shorter Timelines — It streamlines and automates business licensing processes and helps a business to be set up quickly
Data-driven decision making — The application collates valuable information on the economic activity and employment opportunities in a ULB
The TL product features can be broadly classified as the following modules:
Registration, Login and Creation of User Profile
Applying for a Trade License
Trade License Issue
Modifications to a Trade License
Renewal of Trade License
Payments and Fee
Dashboards and Reports
General Features
This section provides an overview of the methodology for State-wide implementation of TL. The Implementation of TL is distributed across seven distinct stages. Each stage has predefined entry & exit criteria and roles & responsibilities. This is to ensure objective monitoring and decision-making for the overall success of the program. Details of each stage are defined in this section.
Note: This document is specific for States that have more than 30 ULBs
TL implementation program is expected to be completed approximately between 38- 42 weeks with the resource deployment by the State and System Integrator (SI) Team (as defined below). However, it is critical that activities and exit criteria set for each stage are achieved to adhere to this timeline.
This is a set of initial critical activities undertaken on receiving a letter of Enrolment or MOU from the State. Successful completion of these activities assures that the program is started with crucial personnel, System Integrator (SI) Teams, and funds.
System Integrator and state will agree on program scope, program timelines, and budgeting & resourcing.
This stage envisages the in-person interaction of crucial State officials and implementation System Integrator (SI) Teams to kick-start the program. This stage may require multiple interactions/meetings with different interest groups. The principal objective of these interactions is to identify scope and planning strategies for phasing/ rollout, create an active collaboration & Governance approach and agree on a high-level timeline for the engagement.
*Exploration is required to understand the Inter and Intra Departmental Jurisdictions of Local Governments with respect to Trade License.
State Baseline Data: A Baseline Template is provided to collect certain vital information like no. of transactions, revenue collected in the last FYs, collection mode, budget data, etc. This data must be collected pre-rollout
During the Solution design stage, key State officials and members, who are subject matter experts, are expected to share State acts and policies and help interpret the same for the System Integrator (SI) Team. This stage baselines the State-specific product features in the Product Configuration report.
Pilot ULBs Specific Product Data Configuration: Master data is required from the Product Perspective for go live. For e.g.: Boundary Data, List of Employees etc. A Master Data Template will be provided for the collection of this particular data type.
This stage consists of a series of developments in accordance with the detailed project plan to ensure the smooth functioning of the customised product. Master Data Collection & Environment Setup will be achieved in this phase. Further monitoring and maintenance strategies are put in place.
During this stage, a demonstration of the product followed by a hands-on session is conducted for the ULB officials. Necessary training of ULB officials and resources required for UAT is conducted and identified respectively. The establishment of the State Support Team and required processes are initiated in this stage.
Note: The Nodal Officer is responsible to identify the ULB officials who are associated with the TL process on the ground and will be working with the technological Product in the respective ULBs
On successful Go-Live in the Pilot ULBs, and further fine-tuning to stabilize the product, the solution will be rolled out to the rest of the ULBs in phases. Guidance and support from the State Team will be required to create the rollout plans and assure the necessary infrastructure for training and deployment is available at each ULB.
Note: The rollout phase needs to be detailed for iterative activities of onboarding ULBs in batches.
Note: Only once all the stages are complete in one batch of the rollout of around 30 ULBs, the next batch begins. There are multiple phases of rollout. The second batch begins after the first batch has successfully fulfilled all the criteria of the Rollout Phase. A typical timeline for the closure of rollout in each batch is 5-6 weeks (in a batch of 30 ULBs)
The final stage consists of strategies to ensure the sustenance of the product in the State. Systems are put in place to ensure the continuous tracking of data and provisions are made to improve the product if new data suggest.
This section outlines the activities involved in each stage of the implementation along with the responsibility and accountability of critical stakeholders - State, eGov Team and System Integrator Team onboard.
TL Cell: TL Cell is the government-appointed body chaired by the Principal Secretary/Secretary, Urban Development Department with members from Urban Development Department etc.
Resource requirements for the TL cell required to be formed by the State
Note:
Designations mentioned above are as per designations already driving TLs implementation at the State level.
The description of each designation is explained below.
These are the preferred figures. In the case of Domain Expert, 2 people are subject to the availability
Description of resource persons:
Project Head: Is the Head of the TL Cell who will drive the project from the State’s Side
Domain Expert: A person who is well aware of the on-ground scenario, well versed with the act, GOs passed, Prevalent Business processes, Deviations from the acts, TL Rates/ slabs applicable
Nodal officer (EO/Commissioner/ Senior Official): the project coordinator in each district to drive the project centrally. Monitor usage post Go Live- point of escalation for Implementation Team, Seasoned and worked in Multiple ULBs on various modules and has a good understanding of TL, Facilitates and Tracks data collection Post Go Live, Monitors and facilitates the adoption of the application. point of contact for eGov, SI and at the HQ level.
MIS Expert: Day-to-day tracking of the data specific to ULBs, data entry, reporting and review to senior officials
eGOv Team: eGov Team is the technical partner of the project which will provide all necessary support to the State concerning the implementation, Program Designing etc.
System Integrator (SI)Team: SI Team will be responsible for consulting, program management and the implementation of products in the ULBs in close collaboration with the TL cell, technical partner (eGov) and various other stakeholders.
Guidelines to read the tables below:
Execute - One who owns the accountability to complete the activity
Consult - One who may initiate, guide and in the process, handhold the execution of the activity
Note: Stage 0 is where the TL cell and SI team is formed, hence there are only two entities playing a role which are that of eGov and the state leadership. Once the TL cell and SI team are finalised, their role begins in the following stages.
Vision: Defining the time frame to go live, the time frame to scale it pan state, the value proposition of the programme for the state and year-on-year financial targets and adoption targets
Project Plan: A detailed plan of Program schedule/timelines, implementation phases, team structure and ongoing support and maintenance is required.
System Integrator: The Entity/Company collates all the subsystems required for the project and integrates them to achieve the program objective
Program Charter: Outline of implementation plan agreement with priority applications and broad timelines, program governance model, program success metrics and capacity building.
Acceptance Letter/MOU: Formal Acceptance/Sign Off of the Client State with a clear mandate of the Program
Program Success Metrics: Defining the parameters (which are measurable) prior to the program, on which the success of the program is to be measured on the completion of the program
Project steering committee: The key body within the governance structure is responsible for the business issues associated with the project that are essential in ensuring the delivery of the project outputs and the attainment of project outcomes.
Project governance: Set of policies, regulations, functions, processes, procedures and responsibilities that define the establishment, management and control of projects, programmes and portfolios.
Scoping: List of activities measured against the time taken to complete them in accordance with the project goals
Baseline data: Set of information that serves as a foundation to compare other data acquired afterwards
Project Kick-off meeting: Meeting with the project team and the client of the project. This meeting would follow the definition of the base elements for the project and other project planning activities
Fitment Study: GAP Study of the Existing/Required Field Process Vs Product
Data migration: Existing Records of the functional activities need to be moved into the Database of the newly released Application
Data collection: Required data for the roll-out of the applications, which needs to be collected from the existing functional process
Data validation approach: This approach enables the sanctity of the Data with built-in validation by the Design
Data synchronization: The process of establishing consistency among data from a source to a target data storage and vice versa and the continuous harmonization of the data over time.
Pilot Implementation: Any new process is tested out as a pilot in one or two instances before pan implementation
Pilot ULB: The ULBs selected for the pilot implementation are called pilot ULBs.
Roll out: On successful clearance of the Pilot, the Process/Application/Services are implemented across all Offices/ULBs
Deployment: Deployment defines the complete package of Software components set up in a particular environment
Customization: Details of changes to be made in the Product to comply with the needed field process
Configuration: Defining existing content such as Options and Variables based on the requirements on the ground
Product walkthrough: Explaining to the users step-by-step through a set of actions that they need to take to achieve a specific outcome
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by is licensed under a .
Once the are defined, the next task is to -
Sr. No. | Trade Type Code* | Trade Type Name* (In English) | Trade Type Name* (In Local Language) | Trade Category Code* |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
The computerized and automatic Trade License system offered by eGov, facilitates citizens who seek to apply for a Trade License within any Urban Local Body with a transparent, speedy, hassle-free and user-friendly procedure. Trade License (TL) is one of the components of a smart city that ensures a check on all the trade practices and increases the ease of conducting business within the state. Keeping in mind the benefits associated with the product offered, the proposed system is about to be implemented in 500+ ULBs across the country in 15 states. (For details on product features refer to )
Stage Four - is about doing a pilot launch in UAT and including all the necessary feedback on the product. Stage Five - the roll-out of the product is done at the State level (Go Live) from a couple of ULBs to pan State coverage in batches. Finally, in Stage Six sustenance and ongoing improvements are worked upon while the product is already functioning in the State. (For details on the implementation plan refer to )
to view module capabilities and product functional specifications.
Stage 0 - Program Setup/ On-Boarding |
---|
*Details of TL cell is mentioned in of this handbook
Stage 1 - Program kick-off |
---|
#Details of TL cell is mentioned in of this handbook
Stage 2 - Solution Design |
---|
Stage 3 – Configuration & Customization |
---|
Stage 4 – UAT & Go Live |
---|
Stage 5 – Rollout |
---|
Stage 6- Sustenance and Ongoing Improvement |
---|
Resource Name | No. Of Resources |
---|
Stage 0 - Program Setup/ On-Boarding |
---|
Stage 1 - Program kick-off |
---|
Stage 2 - Solution Design |
---|
Stage 3 – Configuration & Customization |
---|
Stage 4 – UAT & Go Live |
---|
Stage 5: Rollout |
---|
Stage 6- Sustenance and Ongoing Improvement |
---|
Areas | Assumptions |
---|
All content on this page by is licensed under a .
1 | TRADE_TYPE_MEDICAL | Hospital | अस्पताल | TC1 |
2 | TRADE_TYPE_HOTEL | Hotels | होटल | TC2 |
1 | The format of the Trade Type Code defined should be alphanumeric and unique | TRADE_TYPE_MEDICAL TRADE_TYPE_HOTELS |
2 | Trade Type Name (in either language) should not contain any special characters | Hospital: [Allowed] #Hospital! : [Not allowed] |
Duration | 4-6 weeks |
Entry Criteria | Acceptance Letter/MoU by State |
Exit Criteria |
|
Duration | 4-6 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 4-6 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 6-8 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 2-3 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 5-6 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria | State-wide Rollout in batches:
|
Duration | Ongoing process |
Entry Criteria |
|
Key Ongoing Activities |
|
Project Head | 1 |
Domain Expert | 2 |
District Nodal Officer | 1 per district |
MIS Expert | 4 |
Task/Activity | eGov | State Leadership |
Appoint of TL Cell | Consult | Execute |
Finalise funding for the program | Consult | Execute |
Define state -specific procurement process | Consult | Execute |
System Integrator(SI) Team sign-up/onboarding | Consult | Execute |
Finalise Trade License Program Vision | Consult | Execute |
Task/Activity | eGov | TL Cell | SI Team |
Identify & agree on scope and exclusions | Consult | Consult | Execute |
Identify pilot ULBs | Execute | Consult |
Project Kickoff - Implementation Methodology Presentation | Consult | Consult | Execute |
Product Walkthroughs | Consult | Execute |
Define Project Steering Committee structure and Project Governance process | Consult | Consult | Execute |
Define phases of deployment/ rollout | Consult | Execute |
Agreement on Deployment Priorities and high-level delivery timelines | Consult | Execute |
Identify and study all TL process | Consult | Execute |
Finalize Program Success Metrics for Adoption and Governance adhering to the vision of the program | Consult | Consult | Execute |
Stage 1 - Program kick-off |
Task/Activity | eGov | TL Cell | SI Team |
Internal Capacity Building, program logistics at State and ULBs, as per the current scenario | Execute | Consult |
Collection of baseline data to measure end line target for the product (Revenue generated, total properties in ULBs etc.) | Consult | Execute | Consult |
Circulation of baseline data collection templates to the state/SI Team | Execute | Consult |
Task/Activity | eGov | TL Cell | SI Team |
Standardisation of all TL processes | Consult | Execute |
Define criteria for success | Execute | Consult |
Initiate policy change, if needed based on Processes defined | Consult | Execute | Consult |
Conduct Product familiarisation workshop | Consult | Execute |
Initiate collection of master data from pilot ULBs | Consult | Execute |
Finalise data migration/collection/sync-up approach | Consult | Execute |
Finalise data validation approach | Execute | Consult |
Capacity Building for making state team aware about basic usage of tools like MS Office, mails etc. | Execute | Consult |
Dashboard design finalisation for Program Tracking | Execute | Consult |
Task/Activity | eGov | TL Cell | SI Team |
Setting up development environments | Consult | Execute |
Development/customisation of reports and dashboards | Consult | Execute |
Development/Integration of portal | Consult | Execute |
Third-Party Integrations (Payment gateway, Handheld/pos device) | Consult | Execute |
Updation of user manuals and other key documents | Consult | Execute |
Preparation & execution of Test Cases | Consult | Execute |
Setup monitoring, support & maintenance processes, tools and dashboards | Consult | Execute |
TL legacy data collection from Pilot ULBs (at least) | Consult | Execute |
Capacity Building for making state team aware about basic usage of tools like MS Office, mails etc. | Execute | Consult |
Verification and Migration of Pilot ULB data | Consult | Execute |
Identification of participants for UAT session | Execute | Consult |
Task/Activity | eGov | TL Cell | SI Team |
UAT Environment Setup | Consult | Consult | Execute |
Issues/bug identification and resolution | Consult | Execute |
Regression UAT and sign off from Pilot ULBs/ State | Execute | Consult |
Setting up the Production environment | Consult | Execute |
Setting up Support Centre & processes (Help Desk) | Execute | Consult |
Training user | Execute | Consult |
Training Trainer | Consult | Execute |
Stage 4 – UAT & Go Live |
Task/Activity | eGov | TL Cell | SI Team |
Training the Support Resources | Consult | Execute |
Marketing & promotion activities | Execute | Consult |
Go Live & launch event | Consult | Execute | Execute |
Setup of review and monitoring cadence/team | Execute | Consult |
Task/Activity | eGov | TL Cell | SI Team |
ULB configurations phase wise as per the Project Plan | Consult | Execute |
Verification and Migration of ULB data phase wise as per the Data Agreement Sign Off provided by the State | Execute | Consult |
Establishment of bug ticketing tool for resolving ground level issues by the state team | Consult | Execute |
Training the Users at the district level | Execute | Consult |
Pan State Roll Out – Phase wise | Consult | Execute | Execute |
Stabilise product | Consult | Execute |
Task/Activity | eGov | TL Cell | SI Team |
Adoption Review Meetings as per the vision defined for the program | Consult | Execute | Consult |
TL Cell Focuses on Using data for:
| Execute | Consult |
Plans of ongoing Sustenance in Place with respect to:
| Consult | Execute | Consult |
Infrastructure |
|
Project Scope |
|
State Team |
|
Documentation |
|
Training |
|
Implementation |
|
1 | Trade Type Code | Alphanumeric | 64 | Yes | The Code assigned to the Trade Type. Eg: TRADE_TYPE_MEDICAL is assigned to Hospitals |
3 | Trade Type Name (In English) | Text | 256 | Yes | Name of the Trade Type in English. Eg: Goods, Services etc. |
3 | Trade Type Name (In Local Language) | Text | 256 | Yes | Name of the Trade Type in Local Language (as decided). Eg: Service is described as “सर्विस” in Hindi |
4 | Trade Category Code | Reference | 64 | Yes |
1 | Make sure that each and every point in this reference list has been taken care of |
The Trade Category List can be defined as the primary or the 1st level classification “head” for trade(s) defined at a ULB/State Level.
The table above contains sample Trade Category data.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Enter a unique Trade Category Code for each trade head.
Enter the Trade Category Name. Some trade categories are already defined in the master. Add new categories as required.
Enter the Trade Category Name (Local Language).
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
Trade Type can be further sub-classified into Trade Sub Type depending on the trade ontology existing in the ULBs or States. Hence, Hotels can be further classified into Dhabas in North India or Udupis in South India.
Once the Trade Type(s) are defined, the next task is to -
Define Trade Sub Types
Map Trade Types to corresponding Trade Sub Types
The table above contains sample data.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Select the relevant Trade Type Code from the Trade Type master data. This will map the listed Trade Sub Type to the selected Trade Type.
Enter a unique value for Trade Sub Type Code.
Enter the English name for Trade Sub Type Name (English).
Enter the local name for the Trade Sub Type Name (Local Language).
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
Once the Trade Ontology is defined, the next step is to allocate the license fee associated with the Trades.
Following are the key tasks to be executed :
Allocate the License Fee according to Trade Classification Level (Types/Subtypes).
Map the License fee with the respective Trade Classification Level.
The table above contains sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
Collect the above information and feed it below the “Trade Sub Type Name” column accordingly. The Description of Trade Sub Type Name must be provided as per the language specified in the respective column.
Add the “Trade Sub Type Code” respectively against the identified trade type(s).
Fill in the New License Fee & New Renewal Fee accordingly. The New License Fee & Renewal Fee can be the same as well as distinct, depending on the by-laws/ mandate followed by the State/ULB.
Fill in the fields related to Units of Measurement (UOM Unit, From/To) for the available trades only.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
The structure type is the first level of classification of the premises where the trade has to be established and conducted. This is mostly used as management information in the trade detail.
The table above contains sample data.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document for more details on data type, size, and definitions.
Contact the person who shared this template with you to discuss and clear your doubts.
Enter the relevant structure types.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per specifications. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
A separate entity-specific checklist is not needed for this entity data template.
The Code assigned to the . Eg: TC1 For Goods, TC2 for Services
Sr.No. | Trade Category Code* | Trade Category Name* (In English) | Trade Category Name* (In Local Language) |
---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Trade Sub Type Code* | Trade Sub Type Name* (In English) | Trade Sub Type Name* (In Local Language) | Trade Type Code* |
---|---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Dependent on the Trade Classification Level (/ ), the fee allocated might be the same across the Sate or could vary from ULB to ULB. There could be a distinct fee(s) for two different types of applications (new and renewal).
Sr. No | Trade Sub Type Code* | Trade Sub Type Name (In English) | New License Fee* | Renewal License Fee* | UOM | UOM From | UOM To |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Identify the “” that exists at a ULB/ State level.
Sr. No. | Checklist Parameter | Example |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No. | Code* | Structure Type* (In English) | Structure Type* (In Local Language) |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Definition/ Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
1
TC1
Goods
सामग्री
2
TC2
Services
सर्विस
1
Trade Category Code
Alphameric
64
Yes
The Code assigned to the Trade Category. Eg: TC1 For Goods, TC2 for Services
2
Trade Category Name (In English)
Text
256
Yes
Name of the Trade Category in English. Eg: Goods, Services etc.
3
Trade Category Name (In Local Language)
Text
256
Yes
Name of the Trade Category in Local Language (as decided). Eg: Service is described as “सर्विस” in Hindi
1
Make sure that each and every point in this reference list has been taken care of
1
The format of the Trade Category Code defined should be alphanumeric and unique
TC1: Goods
TC2: Services
2
Trade Category Name (In either Language) should not contain any special characters
Goods: [Allowed]
#Goods! : [Not allowed]
1
TRADE_SUBTYPE_CLINIC
Clinic
क्लिनिक
TRADE_TYPE_MEDICAL
2
TRADE_SUBTYPE_DHABA
Dhaba
ढाबा
TRADE_TYPE_HOTEL
1
Trade Sub Type Code
Alphanumeric
64
Yes
The Code assigned to the Trade Sub Type. Eg: TRADE_TYPE_Dhaba is assigned to Hotels
2
Trade Sub Type Name (In English)
Text
256
Yes
Name of the Trade Sub Type in English. Eg: Clinic
3
Trade Sub Type Name (In Local Language)
Text
256
Yes
Name of the Trade Sub Type in Local Language (as decided). Eg: Dhaba is described as “ढाबा” in Hindi
4
Trade Type Code
Reference
64
Yes
The Code assigned to the Trade Type. Eg: TRADE_TYPE_MEDICAL is assigned to Hospitals
1
Make sure that each and every point in this reference list has been taken care of
1
The format of the Trade Sub Type Code defined should be text and unique
TRADE_SUBTYPE_CLINIC
2
Trade Type Name (in either language) should not contain any special characters
Clinic: [Allowed]
#Clinic! : [Not allowed]
1 | TRADE_SMALL_BAKERY | Small Bakery | 2500 | 2000 | Workers | 1 | 20 |
2 | TRADE_SMALL_BAKERY | Small Bakery | 3000 | 2500 | Workers | 21 | 30 |
2 | TRADE_MED_BAKERY | Medium Bakery | 5000 | 4500 | Workers | 1 | 30 |
1 | Trade Type Name (In either Language) should not contain any special characters | Small Bakery: [Allowed] #Small_Bakery! : [Not allowed] |
1 | IMMOVABLE | Immovable | अचल |
2 | MOVABLE | Movable | चल |
1 | Code | Alphanumeric | 64 | Yes | Unique code to identify the records uniquely |
2 | Structure Type* (In English) | Text | 256 | Yes | Structure type in English |
3 | Structure Type* (In Local Language) | Text | 256 | Yes | Structure type in local language e.g. Hindi, Telugu etc. |
1 | Trade Sub Type Code | Reference | 64 | Yes |
2 | Trade Sub Type Name (In English) | Text | 256 | Yes | Name of the Trade Sub Type in English. Eg: Small Bakery |
3 | New License Fee | Decimal | (6,2) | Yes | The fee charged when the license applied for the respective trade for the first time. |
4 | Renewal License Fee | Decimal | (6,2) | Yes | The fee charged when the license applied for the respective trade for the renewal. |
5 | UOM | Text | 64 | No | The Units of Measurement” associated with the Trade. Eg: Workers is the UOM associated with the trade “Bakery” |
6 | UOM From | Integer | 6 | No | Initial Range from which the “Units of Measurement” is applicable for a Trade |
7 | UOM To | Integer | 6 | No | Final Range to which the “Units of Measurement” is applicable to a Trade |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Make sure that each and every point in this reference list has been taken care of |
This service is used to issue a license to the user after verification. The service is designed in such a way that it can be used to serve different type of licenses. Currently used to issue trade licenses, perform stakeholder registration and issue lockdown pass. The service is integrated with workflow where we can define the steps for approval of the application. Once the application is approved the license is generated.
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 tl-services persister config path added in it
PSQL server is running and database is created
Used for license generations in trade licenses, stakeholder registration and issue lockdown pass
Define roles to applicants on successful application to access Building Plan Approval services at the time of stakeholder registration
Generate application number and license number
Support workflows
Provide notification on various status changes for an application
Add MDMS configs required for Trade License and BPA stakeholder registration and restart MDMS service
Deploy the latest version of tl-services service
Add tl-service persister yaml path in persister configuration and restart persister service
Add Role-Action mapping for API’s
Create businessService (workflow configuration) according to trade license and stakeholder registration
Add tl-service indexer yaml path in indexer service configuration and restart indexer service
Following application properties in the Trade License service are configurable.
The trade-license service is currently used to issue trade licenses, perform stakeholder registration and issue lockdown pass.
Provide backend support for the different license registration process.
Mseva and SMS notifications on application status changes.
The elastic search index for creating visualizations and Dashboards.
Bpa Stakeholder registration provides new roles to the user to access the Building Plan Approval system.
Supports workflow which is configurable
To integrate, host of tl-services service should be overwritten in the helm chart.
{servicename}/_create/ _create should be added as the create endpoint for creating any license in the system
{servicename}/_search/ _search should be added as the search endpoint. This method handles all requests to search existing records depending on different search criteria
{servicename}/_update/ _update should be added as the update endpoint. This method is used to update fields in existing records or to update the status of the application based on workflow.
In all below endpoints if the service name is BPAREG it is treated as a stakeholder registration application and if it is TL or if it is absent then the application is treated as trade license application.
Stakeholder registration APIs:- https://www.getpostman.com/collections/d18b79ccfb69ee8bb526
Trade-License APIs:- https://www.getpostman.com/collections/99f98723c45f97024831
Along with the rates, the Trade License application process does require certain documents as an attachment of proof. The proof can be defined by a set of documents ranging from
Identification Proof (Drivers License/ Voter Card/ Adhaar/ Pan etc.)
Trade Premises Proof (Lease Agreement, Electricity Bills, etc).
Misc Documents (Affidavit, Self- Declaration, etc).
The Number and the Documents required could vary across the State, ULB(s), and might be dependent on Trade Subtypes, all of which are totally configurable on DIGIT.
The table above contains sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Identify the “Trade Sub Types” that exists at a ULB/ State level.
Collect the above information and feed it below the “Trade Sub Type Name” column accordingly. The Description of Trade Sub Type Name must be provided as per the language specified in the respective column.
Add the “Trade Sub Type Code” respectively against the identified trade type(s).
Fill in the *Document 1 & *Document 2 columns respectively.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
Structure sub type is the second level of classification of the premises where the trade has to be established and conducted. This is mostly used as management information in the trade detail.
The table above contains sample data.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document for more details on data type, size, and definitions.
Contact the person who shared this template with you to discuss and clear your doubts.
Enter the relevant structure sub types with its proper mapping with structure type.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per specifications. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
A separate entity-specific checklist is not needed for this entity data template.
Users can review the list of applications and their status registered under their mobile numbers in the My Applications tab. Each Application for the initial view displays the Application No, Service Category, Owner Name (Multiple with a comma), status, SLA, and Trade Name with the View Details option. If the status is pending for payment the View Details & Pay button is available that enables the users to look up more details about the application.
Once the user clicks on the View Details or View Details & Pay button, the Application Details Page is displayed with all the necessary information about the application.
The user can download the Application Acknowledgement Form (status - pending for payment ) or TL Certificate or the payment receipt using the Download Link button available at the top right corner of the page.
If the status is Pending for Payment for the application or Action required by a citizen (discussed elaborately here), a button will be visible to pay or edit at the end of the page respectively. On clicking on the Make Payment button it will redirect to the common pay screen through which the user can make the payment.
Timeline Component - timeline component is present at the end of the application details which tells about the current status and history of the application being initiated, Applied, Pending for Document Verification, Pending for Field Inspection, Pending approval, Pending payment, Approved etc.
The link for the Applications and Application Details main code is given below, it can be used to understand the working of the code, Below is the folder link.
The template for My Application List is present under https://github.com/egovernments/digit-ui-internals/blob/main/packages/modules/tl/src/pages/citizen/Applications/Application.js and Application Details page is present inside - https://github.com/egovernments/digit-ui-internals/blob/main/packages/modules/tl/src/pages/citizen/Applications/ApplicationDetails.js .
All the Application lists are retrieved by calling the search API "/tl-services/v1/_search
". If the view is set as “bills”, all the application is loaded using the hook useFetchBill
which calls the /billing-service/bill/v2/_fetchbill
API. SLA value in the Application List Screen is calculated from the data received from workflow API : /egov-workflow-v2/egov-wf/process/_search
Following is the hook used for the trade search API.
To get the Application details in key-value format, in order to make it more compatible, the following hook is being used, which is a common service to be used across modules.
No MDMS data is being used here, all the data is being loaded from Search API/Fetch Bill API.
For My Applications also the localization keys are added in the ‘rainmaker-tl’ locale module same as other parts of the TL module. Change, update or add any new localization key is done in the same locale module only.
Trade License Calculator service is used to calculate the Trade license fees / renewal fees based on the defined billing slabs. This service enables the TL admins to create billing slab with different combination of license type, trade type, structure type and accessory type. The service is designed in such a way that it can be used to serve different type of licenses.
Before you proceed with the configuration, make sure the following pre-requisites are met -
Java 8
Kafka server is up and running
egov-persister service is running and has tl-calculation-persister & tl-billing-slab-persister config path added in it
PSQL server is running and a database is created to store TL Application data
Following services should be up and running:
egov-perister
egov-mdms
tl-services
billing-service
TL Admin an Employee of ULB with TL_Admin role can create, update billing slab(s)
ULB Employee with TL_CREATOR and TL_ADMIN can search billing slab(s)
TL service internally calls tl-calculator to generate demand.
Deploy the latest version of tl-service and tl-calculator
Add tl-calculation-persister.yml & tl-billing-slab-persister.yml file in config folder in git and add that path in persister . (The file path is to be added in environment yaml file in param called persist-yml-path )
tl-calculator will be integrated with tl-services. tl-services internally invoke the tl-calculator service to calculate and generate demand for the charges.
Tl calculator application is used to calculate the Trade license Fees based on the different billing slabs in the DB that's why the calculation and demand generation logic will be separated out from TL services. So in future, if calculation logic needs to modify then changes can be carried out for each implementation without modifying the TL services.
TL application to call /tl-calculator/v1/_calculate to calculate and generate the demand for the TL application
ULB Employee can create billing slab calling /tl-calculator/billingslab/_create
ULB Employee can update billing slab calling /tl-calculator/billingslab/_update
ULB Employee can search billing slab calling /tl-calculator/billingslab/_search
TBD
(Note: All the API’s are in the same postman collection therefore the same link is added in each row)
__
__
Objective: To provide the facility for the user to create a trade license application for the current year by citizen or counter employee.
Users can apply for a trade license application by clicking on the Apply for Trade License button. Users can add all the information as per the questions asked across the workflow. The summary screen at the end of the flow displays all details for review. Users can click on the submit button after review. The application for a trade license is created for the current financial year.
Apply Flow - The trade license registration screen is displayed after login which helps users identify the documents required to apply for a trade license. A citizen info card at the bottom of the page displays any additional information about the maximum size of the file that can be uploaded.
Trade License Details/Assessment Flow - This flow captures the trade-specific information required for registering the trade.
Trade Name - The user provides the name of the trade. An info card is displayed at the bottom of the screen stating that the license will be issued for the current financial year. The financial year value is retrieved from the MDMS.
Structure Type - The users can select yes or no based on whether the trade has mobility or not. If yes, the next screen prompts you to enter the vehicle type. If no, the next screen moves to the building type page.
Vehicle Type / Building Type - The options for vehicle and building type are fetched from the MDMS. The Building Type screen displays an information card about the pucca or kuccha options.
Commencement Date - It defines the date on which the trade started or will start in the future.
Trade Units - Users must provide the trade category as either goods or services. Based on the selected option the Trade Type is loaded from the MDMS as a drop-down list. The trade sub-type options are loaded based on the selected trade type. The unit of measure and UOM value get pre-populated from the MDMS as per the options selected above.
Users must enter at least one unit to move forward. Clicking on Add More Unit option enables users to enter additional units. Clicking on the delete icon on the top right corner of the unit card removes the unit.
Accessories - The Accessory page inquires if there are any accessories required for the business. Accessories may not be compulsory for all trades. If yes, it will move to the accessory details page. If no, it will skip it altogether and will load the address flow.
Accessory details - The options for accessories are retrieved from the MDMS. The Unit of Measure or UOM is pre-populated and cannot be edited. The users can edit the UOM value and the accessory count. In some cases, these are pre-populated from the MDMS. Clicking on Add More Trade Accessory button allows users to add multiple accessories.
Common PT integration with TL: After entering the trade details, users have the option to either search and integrate the already created property or create new lightweight property data for the trade license. This step can be skipped and users can proceed with the normal address details flow.
Once a property is selected user can see the details of the property on the property details page. Refer to the Common PT document for more details.
Address Details Flow - In the next flow, users have to enter the trade address details. This flow is straightforward, without any conditional routing.
Users can pinpoint the location in the Geo-location map, according to which pin code and city, as well as locality, is auto-filled.
Owner Details Flow - Finally, the users need to enter the trade owner details. Ownership can be Single or Multiple Owners. According to which the details are filled.
In the case of single/multiple owners, the following screen is displayed. The remaining flows remain the same.
Users can add multiple owners by clicking on the add owner button - a similar functionality as in trade units and accessories. The Add Owner button is not visible in case the user selects a single owner on the previous page.
The user must provide the owner's primary address and upload three documents that include address proof, owner identity and owner photograph.
Check Page and Acknowledgement Screen - Users can cross-verify the data entered throughout the flow in the Check page. Clicking on the change option adjacent to the data fields allows users to make any changes or updates to the data. The user is redirected back to a corresponding information page and the entire flow is repeated once again to submit the application.
The Applying of Trade License Create API is called. Create API snippet:1create: "/tl-services/v1/_create"
If the API response is successful, then the Acknowledgement Screen is displayed, otherwise Failed Acknowledgement Screen is displayed.
Clicking on the Download Acknowledgement Form button downloads the PDF copy of the acknowledgement.
All screens are developed using the new-UI structure followed previously in FSM, PGR and PT, except for multi-component.
Apply Trade License main index link: https://github.com/egovernments/digit-ui-internals/blob/main/packages/modules/tl/src/pages/citizen/Create/index.js
The TL (Trade License) module is segregated into a specified structure. The screen configuration is inside the PageComponent folder, and the configuration for routing of the pages are mentioned under the config folder which is common for both citizen and employees. Below is the snippet for folder structure and routing configuration.
The pages folder is where the high-level configuration for controlling the whole flow is mentioned, for citizens and employees. Citizen flows include Create, Edit Trade, Renewal, Applications and Search Trade. The index or the starting point of the entire flow is available in this folder.
In the Accessory-details page, the Billing slab search API "/tl-calculator/billingslab/_search"
is called. This returns the array list of all the accessories for which the billing slab has been configured. If the response returns an empty array then the options are curated from the MDMS API mentioned in the MDMS data section.
After completing the flow the user can download the acknowledgement PDF form of the License created. PDF generation config link: https://github.com/egovernments/digit-ui-internals/blob/main/packages/modules/tl/src/utils/getTLAcknowledgementData.js
The Utils folder basically contains all the methods used throughout the TL module. Additional common methods can be imported and added to this folder.
For creating an application the Create API from Trade License is called using the React hooks. This is declared in the hooks/elements/TL as TLService.
There are multiple pages within the workflows where data is imported from the MDMS. The table below lists the pages .js files for distinct page components.
React Hooks are used to calling MDMS data that is shared across the modules. Below is the code snippet for the MDMS call.
Localization keys are added to the ‘rainmaker-tl’ locale module. In future, if any new labels are implemented in the Trade License (Citizen) it is pushed to the locale DB in the rainmaker-tl locale module. Below is an example of a few locale labels.
This feature allows the user to edit the application already created under their mobile number. After verifying employee can send the application back to the citizen with remarks on any changes that needed to be done, which can be edited by the user using this flow.
On the Application details page, on the employee side, if the application is marked with “Send Back to Citizen”, the edit option will appear dynamically at the end of the application details page, which the user can navigate through my applications.
After this, On clicking the button, the user can edit the trade license details by going through the Create Flow again. First, it will land on the Summary page, where for each section “change” button is there. Clicking on the Change button, the user will be redirected to the particular content, the only exception here will be the values will be pre-populated from the License object received from Trade License Search API, on completing the flow, Update API will be called and License application will get successfully updated.
Edit Trade License main index can be found in the link given below:
Here the main code consists of the function which results in transforming the License object received in Search API to the object structure which is suitable for citizen Apply flow (owner details, units, accessories etc), as the user needs to go through Apply flow again with pre-populated details and update the value of any accordingly. it also consists of the routing for the pages in the Apply flow.
getTradeEditDetails() function is being used so that the License object which is received from the Trade Search API, is converted to the Apply flow relevant structure so that the values can be pre-populated for the user convenience, on completing the flow, the application is updated. The link for the same can be found below:
Similarly, for owners the method which is used to form the new request param array is gettradeownerarray
It is similar to Accessories and Units - the only difference is in UI. Users can’t select multiple owners and only add one owner, it needs to either add more than one owner or select a single owner in the ownership category and proceed. After the successful update, the application's next action will be “Pending for document verification” as there is an update in the data.
On completing the flow, the same object structure which was being used earlier in the flow gets changed into the request body structure for the update API: /tl-services/v1/_update
, for this, the method which gets used is declared inside the Utils folder. Method name: convertToResubmitTrade
and it can be found in the below link:
MDMS data that is being used here is the same as the Apply flow only, as the flow structure used for edit trade is the same as the Apply for Trade License. Please refer to the link for detailed MDMS information.
For Edit Trade also, the localization keys are added to the ‘rainmaker-tl’ locale module. Change, update or add of any new localization key is done in the same locale module only.
The Code assigned to the . Eg: TRADE_SMALL_BAKERY is assigned to Bakery
Property | Value | Remarks |
---|---|---|
Title | Link |
---|---|
API | Description |
---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | *Trade Subtype Code | *Trade Subtype Name (In English) | *Application Type | *Document 1 | *Document 2 |
---|---|---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Code* | Structure Sub Type* (In English) | Structure Sub Type* (In Local Language) | Structure Type Code* |
---|---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Definition/ Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
PageComponent | MDMS Detail | Module Details Name | Master-Detail Name |
---|---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
User can delete and add as many accessory or units as it needs but there should be at least one unit to complete the application, to add a new unit or accessory “Add” button is used which is located at the end of the page. A new array is formed with all the updated details or with the old unit/accessory, when the flow is completed, this new array is then compared with the old array of accessories and units, and a new resulting array object is formed for the request body, you can find the respective code in the following method : gettradeupdateaccessories
& gettradeupdateunits
. this can be found in the below link
egov.idgen.tl.applicationNum.format
PB-TL-[cy:yyyy-MM-dd]-[SEQ_EG_TL_APL]
The format of the TL application number
egov.idgen.tl.licensenumber.format
PB-TL-[cy:yyyy-MM-dd]-[SEQ_EG_PT_LN]
The format of the TL license number
egov.idgen.bpa.applicationNum.format
PB-SK-[cy:yyyy-MM-dd]-[SEQ_EG_TL_APL]
The format of the Stake holder application number
egov.idgen.bpa.licensenumber.format
PB-SK-[cy:yyyy-MM-dd]-[SEQ_EG_PT_LN]
The format of the Stake holder license number
egov.tl.max.limit
100
Max number of records to be returned
citizen.allowed.search.params
tenantId, applicationNumber, limit, offset, licenseNumbers
The search parameters on which citizen can search
employee.allowed.search.params
tenantId, applicationNumber, applicationType, status, mobileNumber, fromDate, toDate, licenseNumbers, oldLicenseNumber, limit, offset
The search parameters on which employee can search
persister.save.tradelicense.topic
save-tl-tradelicense
The name of kafka topic on which create request is published
persister.update.tradelicense.topic
update-tl-tradelicense
The name of kafka topic on which update request is published
persister.update.tradelicense.workflow.topic
update-tl-workflow
The name of kafka topic on which update request is published
Local Setup
API Swagger Documentation (Trade License)
{servicename}/_create, _create
This API is used to create an application for the license in the system. Whenever an application is created an application number is generated and assigned to the application for future reference.
{servicename}/_search, /_search
This API is used to search the applications in the system based on various search parameters like mobile number, the application number, status etc.
{servicename}/_update, _update
The _update API is used to update the application information or to forward the application from one state to another.
In the case of the stakeholder registration if the application reaches the last stage the role depending on the license type is given to the user.
{servicename}/{jobname}/_batch, /_batch
Searches trade licenses that are expiring and send a reminder SMS to owner's of the licenses
1
TRADE_SMALL_BAKERY
Small Bakery
New
PAN/VOTER ID
LAND LEASE
2
TRADE_SMALL_BAKERY
Small Bakery
Renewal
PAN/VOTER ID
ELEC BILL
1
Trade Sub Type Code
Reference
64
Yes
The Code assigned to the Trade Sub Type. Eg: TRADE_SMALL_BAKERY is assigned to Bakery
2
Trade Sub Type Name (English)
Text
256
Yes
Name of the Trade Sub Type in English Eg: Clinic
3
Application Type
Text
256
Yes
Type of application for which the documents related to trade are configured. It can either be new or renewal
4
Document 1
Reference
256
Yes
The primary document required as a verification parameter. Refer to the Standard Document List
5
Document 2
Reference
256
Yes
The Secondary Document required as a verification parameter. Refer to the Standard Document List
1
Make sure that each and every point in this reference list has been taken care of
1
Trade Sub Type Name (In either Language) should not contain any special characters
Small Bakery: [Allowed]
#Small_Bakery! : [Not allowed]
1
PUCCA
Pucca
पक्का
IMMOVABLE
2
KUTCHA
Kutcha
कच्चा
IMMOVABLE
3
HDV
Hand Driven Vehicle
हाथ चालित वाहन
MOVABLE
4
MDV
Motor-Driven Vehicle
मोटर चालित वाहन
MOVABLE
1
Code
Alphanumeric
64
Yes
Unique code to identify each and every record uniquely
2
Structure Sub Type* (In English)
Text
256
Yes
Structure sub type in English
3
Structure Sub Type* (In Local Language)
Text
256
Yes
Structure sub type in local language e.g. in Hindi, Telugu etc.
4
Structure Type Code*
Reference
64
Yes
Unique code of structure type to establish the mapping with Structure Type
1
Make sure that each and every point in this reference list has been taken care of.
Title
Link
tl-calculator/billingslab/_create
tl-calculator/billingslab/_search
tl-calculator/billingslab/_update
tl-calculator/v1/_calculate
TradeLicense
List of documents required for registration
TradeLicense
Documents
SelectTradeName
Current Financial Year
egf-master
FinancialYear
SelectVehicleType
Type of mobility trade
common-masters
StructureType
SelectBuildingType
Type of Steady Trade
common-masters
StructureType
SelectTradeUnits
List of trade category and its corresponding type and sub-type
TradeLicense
TradeType
SelectAccessoriesDetails
Lit of Accessory and its Unit of measure and UOM value
TradeLicense
AccessoriesCategory
TLSelectAddress
List of cities and its corresponding localities
TradeLicense
tenants
SelectOwnerShipDetails
categories imported are single and multiple owner.
common-masters
OwnerShipCategory
SelectOwnerDetails
List of Gender options.
common-masters
GenderType
API
Action id
Roles
/egov-mdms-service/v1/_search
954
CITIZEN
/tl-services/v1/_create
1685
CITIZEN
/filestore/v1/files/url
1528
CITIZEN
/billing-service/bill/v2/_fetchbill
1862
CITIZEN
/tl-calculator/billingslab/_search
1684
CITIZEN
/tl-services/v1/_update
1686
CITIZEN
/localization/messages/v1/_search
1531
CITIZEN
Title
Link
API Swagger Contract
Trade License Document
This feature allows the user to renew any trade license applications, which either has been expired or had to be renewed for current financial year (Approved and Paid), it also had integration with the payment component, in order to complete the flow all together for renewal.
Renewal can be two types:
DIRECT RENEWAL
EDIT RENEWAL
Once the user clicks on Renew Trade License button on the home page, it will redirect to the renewal list page which will display all the applications eligible for renewal corresponding to the mobile number on which the user has logged in. It will show the Trade name, License Number, Owner Name and status whether active or expired.
Once the user clicks on Renew Button, it redirects the user to the summary page just like in edit Trade license, with all the values pre-populated from the search API. The info card will be declared so that the user will understand how to proceed with either direct renewal or edit renewal.
If the user just wants to renew the same application without updating any data, it will cross-verify all the values in the summary page and then click on submit button directly at the end of the page, this will lead the application to the next status as pending for payment and user can go through payment flow from the acknowledgement screen also, by clicking on the Make Payment button.
If the user before renewal needs to update the application, they can do so by clicking on the change button on the summary screen, this will tell that the flow has been changed from direct to edit renewal, and the user will need to follow the same apply flow in order to complete the editing part of it. the values from the application will be pre-populated in the respective screens, to get the details about the edit flow, one can refer to this link. Send Back Flow - Edit.
Once the user clicks on submit button it will change the current action of the application to pending for document verification as the data has been updated.
Renewal Trade main index can be found in the below-given link:
in this, we are calling the trade license search API, In order to get all the applications, through which the sorting is happened to classify which applications are eligible for renewal for the current financial year.
the hook which has been used for the API is:
The data from here then are sorted into the application which doesn’t have any open renewal application for the current financial year or which has a status of approved or expired. the significant method to get the renewal list of applications is mentioned below:
From here the Trade License List Component has been called which displays the list of the renewal application.
The main functionality of converting the License Object received from the API to the object structure for formdata for apply flow, following is done in a similar way as the edit trade, and the same method is being used to convert the response object, to know more details please refer to Send Back Flow - Edit
Once the user has completed the flow as required or clicked the submit button directly, the method convertToEditTrade
is being called, which re-arranges the data for the request body for the updated API /tl-services/v1/_update
.
If it is a direct renewal only one update API is being called which updates the financial year only.
but if it is an edit renewal, two updated API is called after the first API successful call the application status gets changed to Initiated but after the second API call it is changed to applied. with the next action pending for document verification.
the code for these can be found in the utils folder index please refer to the below link for the same:
https://github.com/egovernments/digit-ui-internals/blob/main/packages/modules/tl/src/utils/index.js
MDMS data which is being used here is the same as the Apply flow only, as the flow structure used for edit renew trade is the same as the Apply for Trade License. Please refer to the link for detailed MDMS information.
For Renew Trade also, the Localization keys are being added in the ‘rainmaker-tl’ locale module. Change, update or add of any new localization key will be done in the same locale module only.
Search Application and Search License pages are used for searching any application/ license that may or may not be relevant to the workflow action of the logged-in users.
Search Application has 2 components.
A search field component is a form which takes inputs and passes them into tl-search API params. It utilizes SearchForm and SearchField components to create and arrange the form.
Result Table uses the Table react component and the result from API is adapted to the table config using a custom hook inside the common parent wrapper and passing the response to individual components.
Search License has a fixed param where the status of the application is “APPROVED”, other than differences in table config
The API end point for searching trade licenses is {env}/tl-services/v1/_search
API CURL -
The Inbox page contains 4 react components:-
Application Links is a separate component that holds links to other pages of possible navigation from the inbox. This component is common in both mobile and desktop views. Links are conditionally rendered according to the user roles.
The Search Application component is a form-based component, that controls the Table component and the search param for Inbox API, it uses FormComposer HOC to render fields.
Validation of these fields is achieved by using controlled component rules
Any number of search fields can be added but by convention, only mobile numbers and application numbers are provided.
Filters contain input fields to filter the result of API, by sending search params to inbox API.
It contains 3 sections
Assigned to Me/ All - It is a radio component to send the assignedToMe param as true or false.
Locality - Filter result according to the selected locality by sending locality code in module search params in inbox API.
Status - Status filters are achieved by sending the id received from the inbox API response and mapping the name of businessService, status name and count
The table is a react component which uses the React-Table plugin, used in multiple modules
However, in Mobile view are using cards to list all the applications without pagination support.
On Inbox page {env}/inbox/v1/_search?_=1627374959930 is the only API that is called.
API CURL -
The trade license 'apply' is the major feature in TL Module. It allows Citizens or Counter Employees to create TL Applications for the current financial year.
Every application is a part of the workflow. Once the user login with TL_CEMP
role, then the User will get the option for creating a New TL Application in the TL card as well as in the inbox.
Clicking on New Application navigates to the New Trade License Application screen.
Initial MDMS call is being made on page load like old UI.
Data fetch, load and render
Clicking on Submit button, tl-services/v1/_create
api is called and create the application, after getting success response, we are calling update API tl-services/v1/_update
.
Acknowledgement Screen
After the success of creating and updating calls will route to the acknowledgement screen.
Provide employee purpose workflow actions.
The same screen is used for both application details and trade details.
Based on the conditions, we are showing the details here
Example: If the application is not in an approved state and the business Service New TL, then we are showing application details otherwise we are showing trade details.
For workflow action details, please refer to the file below.
The workflow is the same as Old UI only, please refer to the documentation link below.
File path: and
Route:
File Path:
Structure Type and Sub Structure Type field data is fetched from
Trade Category, Trade Type, Trade Sub Type field data is fetched from
Mohalla Data - (For Amritsar)
Accessories -
Type of Ownership and Type of Sub ownership -
documents:
On loading the page, /tl-calculator/billingslab/_search
api is called for showing the licence type (File Path: ) and accessories options (File Path: ).
File Path:
S.No. | API | Roles | Action ID |
---|
File Path:
It is common for all modules, find the path here:
S.No. | API | Roles | Action ID |
---|
1 |
|
|
|
2 |
|
|
|
3 |
|
|
|
4 |
|
|
|
1 |
|
|
|
2 |
|
|
|
3 |
|
|
|
4 |
|
|
|
5 |
|
|
|
An illustrative guide to using the TL module
The Trade License (TL) module offers the citizens and governance bodies a convenient and transparent means of processing trade licenses. Trade license is the permission issued by the local governing bodies to carry on specified business or trading activity within the authorized area. It is a mandatory document required to run a business or commercial activity of any type.
The TL module enables citizens to apply for trade licenses or renew existing licenses online. It facilitates the governing bodies to validate and approve the license applications.
This section guides you through the details of using the TL module for each role. Click on the relevant role below to learn more about how to use the TL system.
All the fields in this flow are the same as the New TL Application. The difference here is that max fields are having pre-populated data (On Loading the page, search is made for that particular application).
Will get the Renew Trade License option, when the application is in an approved state and the same financial year application is not present in the workflow.
When we click on the Renew Trade License application, it will route to Renew screen
Direct Renewal: There is no change in any fields and directly clicks on submitting an application, an update API call is made for the respective application with respective to Direct Renewal (applicationType
: RENEWAL
, workflowCode
: DIRECTRENEWAL,
)and it will go into direct renewal flow.
Edit Renewal: If there is any change in any fields and clicks on submitting an application, an update API call is made with respect to edit renewal (applicationType
: RENEWAL
,workflowCode
: EDITRENEWAL
)and update the application and it will go into the edit renewal flow.
Units, Accessories, Owners and documents details in case of Edit/Renewal flow
Acknowledgement Screen
After a successful update call, the user is routed to the acknowledgement screen.
EDIT Flow: It is also the same as renewal flow only, but we are passing the action action
: RESUBMIT
on the update call with all the changes.
Application/ Trade Details: Application Details/Trade Details
TL Create New Application: New Trade License Application
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Employee can edit units in both cases, employee can add and delete multiple units, please find the file below reg all use cases: digit-ui-internals/TLTradeUnitsEmployee.js at main · egovernments/digit-ui-internals
Employee cannot edit accessories in both cases, the employee can not add and delete multiple units and all fields are in disable state, please find the file below reg all use cases: digit-ui-internals/TLAccessoriesEmployee.js at main · egovernments/digit-ui-internals
Employee can edit in both cases, expect ownership details, ownership details field is in disable state in both cases. please find the file below reg all use cases: digit-ui-internals/TLTradeUnitsEmployee.js at main · egovernments/digit-ui-internals
Employee can edit the documents in both cases, please find the file below reg all use cases: digit-ui-internals/TLDocumentsEmployee.js at main · egovernments/digit-ui-internals
S.No. | API | Roles | Action ID |
---|---|---|---|
User Role
Scope of Action
Role Description
Citizen
Apply for Trade License
Pay for license
Track status of the license application
Download payment receipts
Individuals and business entities
Counter Employee (CE)
Apply for a Trade License
Complete the Payment for Trade License
Keep a track of the status of the Trade License
Download/Print payment receipts, applications, TL certificate
Counter employees who assist citizens and file new trade license applications or renewal applications on their behalf
Document Verifier (DV)
Verify and forward
Send Back
Edit
Employees responsible for verifying the supporting documents submitted by citizens for new trade license or renewal of existing licenses
Field Inspector (FI)
Verify and forward
Send Back
Reject
Edit
Employees who go on to the field (i.e. location of trade) and physically verifies the information provided by the applicant is correct, checks safety precaution followed by the trade owner
Approver
Approve
Send Back
Reject
Cancel TL
The employee who has the final authority to approve or reject the application
1
/egov-mdms-service/v1/_search
TL_CEMP
954
2
/tl-services/v1/_create
TL_CEMP
1685
3
/tl-services/v1/_update
TL_CEMP
1686
4
/tl-calculator/billingslab/_search
TL_CEMP
1684
Learn how to apply for new trade license, renew and pay trade license fee
Citizens represent individuals, communities, or business entities who are the system end-users. The TL module allows business owners to apply for a trade license online or even apply for renewal of an existing license.
The citizen can also approach the Counter Employee (CE) to submit new TL applications or raise renewal requests for existing licenses.
The Citizen or CE role can -
Download payment receipts, license certificates, or applications
Citizens or CE can apply for a new trade license through the DIGIT web portal or the DIGIT mobile app. To apply for a new TL click on the Trade License card available in the Citizen Services section of the DIGIT home page.
Enter your Mobile Number, Name, and City details. Click on the Continue button.
Enter the OTP received on the given mobile number. Click on Continue. The system validates the details and allows the user to log in to the system with the registered mobile number.
Enter your registered mobile number and the OTP received on the mobile to log in. Click on Continue with Whatsapp button to register your service request using the WhatsApp channel.
Click on the Continue button.
Click on Apply for Trade License.
The initial application screen displays the list of documents that have to be submitted for trade license registration. Scroll through the list and make sure the required documents are scanned and ready for submission online.
Enter the Trade Name. Click on the Next button.
Click on the Yes or No option to indicate the Structure Type of the trading premises. Yes to indicate the trade will run on an immovable structure. And, No to indicate the trade will run on a movable structure.
Select Pucca or Kutcha option to indicate the Building Type. The Building Type option appears if the selected Structure Type in the previous screen is Immovable. In the case of Movable structures, the system displays the Structure Sub Type as Vehicle Type. Select Hand Driven Vehicle or Motor-Driven Vehicle option depending on the trading plans.
Enter the Trade Commencement Date. This date indicates the inception or starting date of the trade.
Select the Trade Category as either Goods or Services in the Trade Units screen. Next, select the appropriate Trade Type and Trade Sub Type from the available drop-down list. Click on Add More Trade Units button to append multiple trading units.
Select Yes or No to indicate if you have any trade accessories.
If Yes, select the applicable Accessory from the drop-down list. Enter the Count for the selected Accessory to provide details on the number of accessories required. The system auto-populates the applicable UOM, if any, for the selected accessory. Enter the UOM value. Click on Add More Trade Accessories button to append multiple accessories.
Enable the Location Finder to allow GPS to track the current location. Or, move the pin to the location manually. Alternatively, you can also enter the location in the Search bar.
The Pincode field gets auto-populated if the location is selected on the map. Else, enter the Pincode of the location details manually. Click on Skip and Continue in case you are unable to provide the Pincode details.
City and Locality/Mohalla fields are auto-populated once the Pincode is entered. Else, select the City and applicable Locality/Mohalla from the drop-down list.
Enter the Street Name and Door No. details.
Provide a Landmark to locate the trading premise.
Select either the Single Owner or Multiple Owners option to indicate the type of ownership in the Ownership Details screen.
Enter the Owner Name. Select the applicable Gender and enter the owner’s Mobile Number.
Enter the Owner’s Address. Check the Same as Trade Address box if the owner’s address and trading address are the same. This will auto-populate the trading address provided earlier.
Upload the documents as required.
Validate the information entered in the application summary screen. Click on Change to modify the information if required. Click on Submit button once the filled-in details are found correct and complete.
The system generates a unique application reference number. Click on Download Acknowledgement Form to download and print the acknowledgement.
Citizens can renew their existing trade applications on the DIGIT portal. CE can also apply for TL renewal on behalf of the citizens. To renew TL navigate to the home page and then click on the Trade License option. Click on My Applications. Click on the Renew Trade License option to view the license details for renewal.
The system will display the license details. Click on the Renew button to apply for renewal.
If there are any changes in the trade details, click on the Change button adjacent to the fields before submitting for renewal.
Click on the Submit button once all changes are done and reviewed.
The Trade License is submitted for renewal.
My Applications option allows applicants to view their applications and track their status.
Click on My Applications.
The screen displays all the applications tagged to the registered mobile number. Click on the View Details button to view the application details. In case the application is pending payment click on View Details & Pay button to make the payment.
The Application Timeline displays the current status and completed actions on the selected application. If the application status shows Pending for Payment, click on the View Details and then the Pay button to initiate payment.
Click on Pay redirects the citizen to the internet banking page and make the payment.
Click on Print Receipt to download the receipt. The citizen can also click on the home page to go back to the home page.
A comprehensive guide to an effective module demo
Welcome to the DIGIT-Trade License product demo script. The key objective of the demo script is to walk users through the trade license module and highlight module capabilities and functions.
The Trade License module offers a comprehensive platform that automates the entire trade license approval process. The TL module streamlines the entire process right from the point of citizens applying for a trade license to the trade license certificate generation.
The module aims to address key trade license governance challenges that include -
Most trades are not registered with the city administration
Lack of transparency in the manual application process
Lack of clarity in the trade license fee computation
Key benefits of using the Trade licenses application -
Transparent process and fee computation
The city administration has the registry of trades operating in the city which helps in better planning of resources
Faster issuance of licenses
Consolidated TL application help ULBs -
Plan city infrastructure
data of all restaurants/party halls are available with the ULBs with the amount of waste generated every day - ULBs can plan efficient SWM truck routing logistics to collect the waste
data of markets and hawkers are present - better infrastructure for shopping complexes can be planned
data of manufacturing and textile units are available - ULB can plan for better power management
Vital to know dangerous and offensive trades like cracker sales / Chemical companies to keep fire stations informed of events
Generate revenue and facilitate prompt services to the citizen
Any citizen who runs a business in the city should get his business/trade registered with the ULB. On registering ULB provides a valid license which is valid for a time period.
Citizens in the TL application should provide info about the
Business/trade (name, location, nature of business)
Ownership details of the trade
Required documents prescribed in the application form
Trade units and accessories - accessories are equipment that is required for the trade which might be of dangerous nature or might make noise during operation like compressors, motors, and pumps.
On submit, the application auto-generates the fee that should be paid by the application and on making the payment it moves to the department side for processing.
The fee depends on the trade type and subtype
Employee processing - Clerk - Revenue inspector - Revenue officer
Application submitted by the citizen lands in the clerk's inbox
The clerk's responsibility is to scrutinize the application and documents submitted and check for correctness.
He/she can either request additional documents from the applicant
Or Upload documents on behalf of the applicant
Or Reject the application citing the reason for a rejection
Or if the application and documents are in order, a clerk can recommend the application for field inspection
On forwarding the application, it will reach the Revenue inspector who is responsible for the field inspection of the site on the ground.
He/she does the field inspection on the field and upload the field inspection report to the application.
On attaching the inspection report the user can either recommend and forward the application for license approval or reject the application.
On forwarding, the application is routed to the revenue officer who is in charge of issuing all licenses within the ULB.
The Approver can approve the application and provide a license certificate, which the applicant can download from his login.
Possible use case scenarios for the demo -
Citizen applies for Trade License
Citizen pays the Trade License fee
Citizen applies for renewal of Trade License
Counter employee submits an application for Trade License on behalf of citizen
Counter employee accepts Trade License fee payment
Employee reviews the application and forwards it for document verification
Employee reviews the documents and forwards them for field inspection
Employee approves the trade license application
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Refer to the for step-by-step instructions for each of these demo scenarios.
All content on this page by is licensed under a .
This section illustrates the steps for different employee user roles at the ULB level
Employees can
Log in to the employee portal using your credential.
Click on the New Application option in the top left corner of the landing page.
An employee can create the application on behalf of citizens over the counter.
Select the applicable Financial Year for which the trade license is to be issued.
Fill in the application details (same as given in the citizen application process).
Click on the Submit button once all details are found complete and accurate.
A unique application reference number is generated. This number is used to access the application and for further processing. The citizen receives a notification along with this application number in the registered mobile number.
Click on Inbox to view the list of applications submitted.
Click on the relevant Application Number hyperlink to open and view the application details.
Scroll down the application and click on the Take Action button. Click on Pay.
Enter the Payment and Payer Details. Click on Collect Payment to process the payment.
The system generates a unique payment Receipt Number. Click on the Print Receipt button to print the receipt. Click on the Go Back to Home Page button to navigate back to the home page.
Click on Renew Trade License option on the home page.
Click on the relevant Trade License Number to renew. Edit the trade license details in the application form as required.
Click on the Take Action button. Click on Renew Trade License option.
The user can renew it without modifying the trade details or it can be modified. If it is modified, it goes into application processing similar to a new TL application. If it is not edited then renewal happens in real-time after making payment.
Trade license applications pass through various stages where details are scanned, verified, and inspected before the final approval. The workflows are defined at the State or ULB level and adjusted to meet individual department requirements.
The prescribed stages through which trade license applications are routed include -
Document Verification
Field Inspection
Approval
Log in with Document Verifier credentials.
The employee landing page displays the list of applications waiting for processing. Use the search filters on the page to find specific applications from the list.
Click on the Application Number hyperlink to open the application.
Scroll through the application details and review the uploaded documents.
Click on the Take Action button and click on Verify and Forward option if all documents are found complete and satisfactory.
Select the Assignee Name. The application will be forwarded to the selected assignee for field inspection.
In case, the documents are found incomplete or missing, click on Send Back to Citizen option. This will send back the application to the citizen for necessary action.
Click on the Reject option if the application details are found inaccurate. This will reject the application.
Log in with Field Inspector credentials.
The employee landing page displays the list of applications waiting for processing. Use the search filters on the page to find specific applications from the list.
Click on the Application Number hyperlink to open the application.
Scroll through the application details and review the details.
Click on the Take Action button and click on Verify and Forward option if all details are found complete and satisfactory.
Select the Assignee Name. The application will be forwarded to the selected assignee for approval.
In case, the documents and details are found incomplete or missing, click on Send Back to Citizen option. This will send back the application to the citizen for necessary action.
Click on the Reject option if the application details are found inaccurate. This will reject the application.
Click on Send Back option to send the application back to the previous employee (document verifier in this case) for further action.
Log in with Approver credentials.
The employee landing page displays the list of applications waiting for processing. Use the search filters on the page to find specific applications from the list.
Click on the Application Number hyperlink to open the application.
Scroll through the application details and review the details.
Click on the Take Action button and click on Approve option if all documents and details are found complete and satisfactory. The trade license is approved and a Trade License certificate is issued to the applicant.
Click on the Reject option if the application details are found inaccurate. This will reject the application.
Click on Send Back option to send the application back to the previous employee (field inspector in this case) for further action.
The TL application is approved and the TL Certificate is issued to the applicant. Click on the Download or Print button to download or print the TL Certificate.
All content on this page by is licensed under a .
Online automated management of property tax revenues and collections
DIGIT-Property Tax (PT) is a self-serve web and mobile-based, easy-to-use and configurable product that addresses the objectives of municipal corporations and local government to automate all property tax operations, thus providing property tax assessment and payment services to citizens in real-time.
Manage property database
Property registration feature and title transfer
Various payment options available to citizens to make payments from their convenient places
Auto-generated defaulters’ list and real-time online tracking
This section contains all docs and information required to understand the PT module, its key features, functional scope, and configuration details. Click on the links below to learn more about deploying, configuring, customizing, and using the PT module.
PT Roadmap
PT Workflows
PT Service Configuration
Demo Script
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
Find the list of Related Docs links at the bottom of each page to browse through additional product details
Reach out to us through any of the below-mentioned contact channels for any assistance or additional information on PT module deployment.
#147/J, 1st floor, 10th Cross, 12th Main, 3rd Block, Koramangala, Bangalore 560034
+91 80 4125 5708
contact@digit.org
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
This page provides configuration details for PT master data templates
DIGIT Property Tax facilitate ULBs and citizens to automate the assessment/ re-assessment of property tax for a property and its demand billing and collection. It also enables the ULBs as well as citizens to process the transfer of title of a property in case of a sale, gift or will and captures the history of ownership.
The main features of the product are as given below.
Completely automated assessment and re-assessment of property tax against a property.
Online self-assessment process
Integrated workflow for ULB staff to perform the check and approve.
Transfer of title (Mutation)
Online application
Integrated workflow for ULB staff to perform the check and approve.
Generating the demand
Collection of property tax through various modes (Cash, Cheque, POS (Credit/ Debit Card), NEFT/RTGS, Online - Through Payment Gateway)
Auto calculation of rebate, interest and penalty.
Receipt Register
Cancelled Receipt Register
Demand Register
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Download the brochure to view product features, capabilities, scope and application details
DIGIT-Property Tax (PT) is a self-serve web and mobile-based, easy-to-use and configurable product that addresses the objectives of municipal corporations and local government to automate all property tax operations, thus providing property tax assessment and payment services to citizens in real-time.
Functional overview for stakeholders
The Property Tax System(PT) provides a digital interface to make property assessments, pay property tax, generate payment receipts and monitor tax collection. It can be used by the citizens, Urban Local Body (ULB) counter and field employees and ULB Administrators to accomplish their specific tasks. It is available as a mobile and web-based application.
The PT product features can be broadly classified as the following modules:
Registration, Login and Creation of User Profile
Filling an Assessment for a Property
Searching for a Property
Modifications to a Property
Generate Demand Notice
Payments collection and Receipts
Dashboards and Reports
General Features
OTP Based Login for Citizen via Web/Mobile App
OTP Based Login for Employee via Web/Mobile App
Provision for language selection during first time registration for both Employee and citizens
Provision of creating a personalized Profile for Citizens and employees on Web App
Login Credentials for the various hierarchy of employees
Role-based access for performing different actions relating to property tax modules
With this feature, a citizen and employee can perform a self-assessment of a new property for a financial year. This feature helps in registering the property in the system. The details of the property can be entered online and can be assessed for the calculation of the taxes.
The PT Product is designed in a user friendly manner and reduces chances of error. System calculates the tax automatically and creates the demand. If a user wants to reassess his property due to any reason (for eg, incorrect data, change in property etc), it can be done by editing details of the last assessment.
An employee can edit the details of the last assessment, on behalf of the citizen-based on the owner’s input. Citizen can track down the status of his incomplete assessment. Any incomplete assessment can be searched and completed.
Citizen/CSC can Assess New Property (By Different Financial Years).
Citizen/CSC can Capture Address, Assessment Info, Owner Info.for all types of properties like residential houses, flats and commercial buildings.
o Sample Details captured:
Door Number,
Mutation number,
Number of floors,
Area covered,
Owner and co-owner,
Mailing & permanent address,
Built year
Individual room measurements
The system computes the property taxes automatically as per process and rules of the state.
The system has a facility to make entry in system by inspector after site visit and assessment of the same by the superintendent.
The system supports dynamic calculation for late fees, interest, rebates, etc. as on the day of demand generation.
The system fetches the data of previous year property data while e-filing for current year so that all the dues are calculated.
The system assigns a unique property ID based on the process defined in the ULBs.
Citizen/CSC : View/Print Summary of Filled Form
Assessment Form
Assessment Form is also sent by email to citizen
Upload Documents
Ownership/Title related
ID Proof
Any other statutory documents
Citizen or Employee can track down the status of his incomplete assessment. Any incomplete assessment can be searched and completed.
Citizen/CSC can search for Property by
Mobile No,
City,
Property Tax Unique ID
Citizen/ CSC can view Incomplete Assessments
Citizen/CSC can reassess Searched Property
View Property details and pending dues
The PT system provides the ability to capture mutation and transfer of ownership. It reduces interfaces between the user and the State and thus promote greater transparency. It also helps in reducing the time taken for mutation after registration. The system provides the ability for alteration of assessment after verification and inspection. Any structural changes like addition/extension/reduction of existing built up area or construction type OR utility changes like usage or occupancy have an impact on the increase/decrease in property tax demand. These changes can be handled by the ‘Additional/Alteration of Assessment’ feature.
The System provides the ability for bifurcation/ amalgamation of property. The property bifurcation/ amalgamation undergoes an approval process. The parent property needs to be modified accordingly, which can be done in the system.
Mutation of property and change of ownership details
Capture Extension/ Addition and Alteration and reassessment based on changed property details
Bifurcation of property
Amalgamation of property
System has the capability to automatically generate demand notice for a financial year based on set triggers like time-based roll over on completion of a financial year. The system notifies the citizens about the demand through SMS/Email. The generated Bills can also be grouped and printed for physical distribution by the ULB employees. The system provides the capability to Employees to merge and download bills based on given parameters to plan their distribution drives.
Generate Demand Notice based on periodic basis
Group Demand Notices
Print Demand Notices
Cancel Demand Notices
Send notifications to citizens on demand generation- SMS, Whatsapp, Email, Physical bil
The citizen/ employee can view payment status of previous assessments from Assessment History section. Payment for any assessment with full or partially paid amount can be completed. Receipts for assessment can be downloaded in Assessment history section after searching for the property details.
Payment of Property Tax -Online, Cheque, Cash, DD, during assessment
Partial Payment of Property Tax -Online, Cheque, Cash, DD, during assessment
The system allows a citizen to pay for anyone's property without changing the demand
The system can also be integrated with PoS machines to enable doorstep collection of property tax and issual of receipt
PT reports provides facility to access receipt register, cancelled receipt register, account receipt register, ULB wise PT collection report, DCB Register. All reports can be downloaded in PDF/XLS format.State level administrator can monitor property tax collections, assessments and other information at a state level through dashboards.
State Dashboard : View Reports for Total Collections, Properties Assessed, ULBs on Prod, Usage Type, Payment Distribution
State Dashboard : PT Collection Timeline (Monthly,Weekly)
State Dashboard : ULB Wise (Collection, Assessments)
Cancelled Receipt Register Report
PT Collection Report (ULB/Date Wise)
Notifications - The system has the capability to send notifications to citizens. These notifications can be sent for various steps like - assessment completion, payment reminder, payment confirmation. These notifications can be sent in the language chosen by the ULB through all channels - SMS, Whatsapp, Email.
Legacy Data Migration - The system has the capability to migrate Demand and Collection. In most states, the preliminary step would be to migrate Legacy data of existing properties/connections along with the Demand and Collection details. This would ensure that subsequent demand generation happens through the system.
Configurable Masters - The system provides the following masters that can be configured as per the State’s
Requirements -
Charges & Calculation : Calculation Engine, Rebate, Penalty,
Rate Master
State Masters : Property Ontology, Documents List, Employee Data Mapping, Boundary Data Mapping
System specification in compliance with the Ease of Doing Business (EODB) BRAP 2019
List of Features- Property Tax
The request to change in owners associated with a property in municipal record is known as mutation or transfer of title. To process this request and make the necessary changes in the property records ULBs charge for a fee which is calculated based on the fee defined based on a few parameters.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to understand the headers in the template sheet, their data type, size, and definitions.
Reach out the person who shared the template for further details or to clear your doubts. Identify if the State/ULB has a provision for capturing pipe size for connections.
Identify usage wise mutation fee amount and fill into the given template.
Go through the checklist to verify the data. Make sure that each and every point mentioned in the checklist is covered.
This checklist covers all the activities which are common across the entities.
Not Applicable
Rebate is provided on early payments which are done in month April in every financial year at the rate of 5% when the property is paid fully up to prevailing financial year demand.`
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Get the rebate rate and the amount involved with it.
Get the year and the end date for the rebate period.
Start filling the template from the right which is the rebate percentage and end it with the rebate end date.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed one the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable.
The penalty is defined as an amount which is charged to the citizen in violation of any rule. There would be multiple penalties defined associated with different rules and acts. Penalty rate decides on how and what amount to be calculated for a penalty.
Within DIGIT, the calculation of the penalty amount is configurable at both the State & ULB level.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Identify all the different types of penalty amounts (by percentage/ by a flat amount) etc and fill them in the provided columns respectively.
Fill in the details of the financial year/ date from which the type of defined penalties will be applicable.
The checklist is a set of activities to be performed one the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
This is the amount which is calculated on percentage defined and collected from citizen if failed to pay the property tax demand on time. It is also called the late payment penalty.
The data given in the table is sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Get the interest rate that is being levied over a period of time.
Get the year as well as the date from which this was brought in place.
Start filling the data from the interest rate followed by the rest of the details.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Reform No. | Reform Area | Weightage (score) | Recommendation | Remarks |
---|---|---|---|---|
List of Functionalities | Corresponding Features |
---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Property Usage Code* | Flat Fee Amount* |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
RebateRate(In %)* | MaxRebateAmount* | FlatAmount* | FromFY* | RebateEndDate (DD/MM)* |
---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No. | Penalty Head | *Penalty Rate (In % ) | Minimum Penalty Amount | *Flat Amount | *From Financial Year | *Start Date |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Rate | Minimum Amount | Flat Amount | Maximum Amount | From FY* | Start Date* |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
7
Land administration and Transfer of Land and Property
3
Digitize land transaction deeds of last 10 years at all sub-registrar offices and make the same available on an online system to check for ownership details and history. The metadata should be searchable for each record and a soft copy of the registered deed should be available. The searchable metadata available should be:
i. Name of buyer
ii. Name of seller
iii. Survey no.
iv. Registration number
v. Registration date
The feature of ‘Property Registry’ in the product will enable this recommendation
8
Land administration and Transfer of Land and Property
3
Digitize and publish the updated Record of Rights (ROR) at all Revenue department offices online in public domain for all areas of the State/UT. The searchable metadata available should be:
i. Name of buyer
ii. Name of seller
iii. Date of mutation
iv. Survey no.
The Property tax system enables this capability
9
Land administration and Transfer of Land and Property
2
Digitize and publish data of Property Tax payment dues online in public domain for all the Urban Local Bodies (ULBs) in the State/UT. The searchable metadata available should be:
i. Name of the Property Tax payer
ii. Property Tax dues
iii. Survey no. of land / Unique Identification no. of property
This feature is enabled by the citizens itself
10
Land administration and Transfer of Land and Property
2
Digitize cadastral maps of all rural areas in the State/UT and make them available in public domain
This can be enabled and worked on by the state team
11
Land administration and Transfer of Land and Property
5
Integrate the below-mentioned records on one website:
i. Data of land transaction deeds for last 10 years at all sub-registrar offices (Name of buyer, Name of seller, Registration number, Registration date, Survey no.),
ii. Updated Record of Rights at all Revenue department offices (Date of mutation), and
iii. Data of Property Tax payment dues at all urban areas of the State/UT (Name of the Property Tax payer, Property Tax dues)
iv. Revenue Court case data (Court case number, Name of parties involved, Date of filing of court case, Status of case [Ongoing/Resolved])
v. Civil Court case data (Court case number, Name of parties involved, Date of filing of court case, Status of case [Ongoing/Resolved])
The website should be publicly accessible. It will help in establishing property ownership and identify tax encumbrances. The integration should be done for all areas of the State/UT.
The integration with external portals and systems of other departments can be enabled by state teams who can enhance the offered product to cater to this recommendation
12
Land administration and Transfer of Land and Property
2
Implement an online application system having the following features
i. Mandatory Online application submission including submission of draft deed and other documents
ii. Provision of online payment of Stamp duty and Registration fee
iii. Auto generation of appointment date and time on making the payment of Stamp duty and Registration fee
The system will provide these capabilities which can be customised as per the state specific rules and regulations
13
Land administration and Transfer of Land and Property
1
Provide model deed templates for sale, gift, lease, mortgage and rent in downloadable and editable format along with instructions to use them
This provision is made available through the ULB portal to make these features accessible to the citizens
14
Land administration and Transfer of Land and Property
2
Integrate the mutation process with the registration process and mandate initiation of mutation process (Revenue department and/ or ULB) as soon as the deed is registered. Ensure that:
i. Information to mutation authority to be automatically shared on completion of transaction (registration). This should be considered as initiation of mutation process.
ii. No separate application from transferee to be required.
iii. SMS/email should be sent to transferee/ transferor to inform about the initiation of mutation
The integration with external portals and systems of other departments can be enabled by state teams who can enhance the offered product to cater to this recommendation
Registration, Login, Creation of User Profile
Provision for Language Selection during first time registration via Mobile/ Web App.
OTP Based Login for Citizen/ Employee via Mobile/ Web App
Login Credentials for various hierarchy of employees.
Provision of Personalized Profile for Citizen/ Employee on Web App
Filing an assessment for a property
Citizen/CSC : Assess New Property (By Different Financial Years).
Citizen/CSC : Capture Address, Assessment Info, Owner Info.
Citizen/CSC : View/Print Summary of Filled Form
Searching for a property
Citizen/CSC : Search Property (By Mobile No,City, Property Tax Unique ID, Existing ID).
Citizen/CSC : View the Searched Property
Citizen : View My Properties
Citizen : View Incomplete Assessments
Citizen/CSC : Edit the Searched Property
Citizen/CSC : Reassess Searched Property
Generate demand notice
Generate Demand Notice based on periodic basis
Group/ Print/ Cancel Demand Notices
Send notifications to citizens on demand generation- SMS, Whatsapp, Email, Physical bill
Modifications to a property
Mutation of property and change of ownership details
Capture Extension/ Addition and Alteration and reassessment based on changed property details
Bifurcation/ Amalgamation of property
Payment collection and receipts
Payment of TAX (Online,Cheque,Cash,DD) : During Assessment
Payment of TAX (Online,Cheque,Cash,DD) : Partial Payment
Citizen/CSC : Download Receipts for payments
Dashboards and reports
State Dashboard : View Reports for Total Collections, Properties Assessed, ULBs on Prod, Usage Type, Payment Distribution
State Dashboard : PT Collection Timeline (Monthly,Weekly)
State Dashboard : ULB Wise (Collection, Assessments)
Cancelled Receipt Register Report
PT Collection Report (ULB/Date Wise)
General features
Notification
Legacy data migration
System assigns a unique property ID based on the Process defined in the ULBs.
System has the facility to classify the property based on its type.
System allows changing the type of property.
Configuration masters
Configurable Rate Master (ULB Specific) : Fire Cess/ Building Height
Charges & Calculation : Calculation Engine, Rebate, Penalty
State Masters : Property Ontology, Documents List, Employee Data Mapping, Boundary Data Mapping
1 | RESD | 1000 |
2 | NONRESD | 5000 |
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
1 | Property Usage Code | Alphanumeric | 64 | Yes | Property usage code - the fee depends upon the type of property usage |
2 | Flat Fee Amount | Decimal | (5,2) | Yes | Mutation fee flat amount |
-10% | 300 | 200 | 2018-19 | 01/10 |
1 | RebateRate(In %) | Numeric | (12,2) | Yes | The percentage at which the rebate has to be provided |
2 | MaxRebateAmount | Numeric | (12,2) | Yes | The maximum amount of rebate that can be given |
3 | FlatAmount | Numeric | (12,2) | Yes | The flat amount which is levied |
4 | FromFY | Numeric | (12,2) | Yes | The year for which the rebate is being given |
5 | RebateEndDate (DD/MM) | Numeric | (12,2) | Yes | The date at which the rebate period ends |
1 | Late assessment | 12.5 | 1000 | 500 | 2019-20 | 01-04-2019 |
2 | Unauthorized Construction | 100 | 5000 | 5000 | 2019-20 | 01-04-2019 |
1 | Penalty Rate | Decimal | (12,2) | Yes | The Penalty charged by percentage |
2 | Min Penalty Amount | Decimal | (12,2) | No | The Minimum amount charged as penalty |
3 | Flat Amount | Decimal | (12,2) | Yes | The pre-decided amount that must be charged as penalty on the amount |
4 | From Financial Year | Decimal | (12,2) | Yes | The year from which the penalty rate begins |
5 | Penalty Start Date | Decimal | (12,2) | Yes | The Date from which the penalty amount will be applicable within a financial year |
18% | 200 | 120 | 20000 | 2014-15 | 01/01/2019 |
1 | Rate | Decimal | (12,2) | Yes | The interest rate percentage. |
2 | Minimum Amount | Decimal | (12,2) | No | Min amount of interest penalty levied. |
3 | Flat Amount | Decimal | (12,2) | No | The flat amount which is levied. |
4 | Maximum Amount | Decimal | (12,2) | No | The maximum amount which could be levied. |
5 | From FY | Decimal | (12,2) | Yes | The year from which the interest rate begins. |
6 | Start Date | Decimal | (12,2) | Yes | The date from which this penalty has to start. |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Make sure that each and every point in this reference list has been taken care of. |
The computerized and automatic Property Tax system offered by eGov, facilitates citizens who seek to pay their Property Tax within any Urban Local Body with a transparent, speedy, hassle-free and user-friendly procedure. Property Tax (PT) is one of the components of a smart city that has the capability of providing the highest revenue of a state. Keeping in mind the benefits associated with the product offered, the proposed system is about to be implemented in 500+ ULBs across the country in 15 states. (For details on product features refer to Section-2)
For the offered product, the implementation process can be divided into seven major distinctive stages. Each stage has predefined entry and exit criteria, roles & responsibilities to assure objective monitoring and decision-making for the overall success of the engagement. The whole implementation lifecycle is typical of 38-42 weeks for the State, keeping in mind the entry, and exit criteria defined at the beginning and end of each stage are met on time recommended.
Stage Zero-program setup and onboarding is a pre-requisite for the initiative to kick off and requires setup of the governance model, implementation Team and decision regarding other significant elements of the initiative like funding and procurement process. Stage One requires scoping of the initiative and decisions on the priorities for implementation by the State Implementation Team.
Stage Two - the State Team works on identifying and finding solutions to the significant gaps in the product offered with respect to the need of the State. Stage Three - involves the Configuration and customization of the product offered. This involves working on various aspects of State-specific needs and incorporating them into the product offered.
Stage Four - is about doing a pilot launch in UAT and including all the necessary feedback on the product. Stage Five - the roll-out of the product is done at the State level (Go Live) from a couple of ULBs to pan State coverage in batches. Finally, in stage 6 sustenance and ongoing improvements are worked upon while the product is already functioning in the State. (For details on the implementation plan refer to Section 3)
Implementation of Property Tax (PT) requires meticulous planning and close coordination between various stakeholders at the centre and State levels. The success of the initiative is dependent upon many factors like strong Program governance, availability of trained resources, financial planning, targeted Implementation Team onboarding, focus on last-mile capacity building and ensuring necessary support to the Urban centre. Achievement of all these factors will provide the most effective and efficient roll-out and adoption of the Property Tax System in the State.
The Property Tax System(PT) provides a digital interface to make property assessments, pay property tax, generate payment receipts and monitor tax collection. It can be used by the citizens, Urban Local Body (ULB) counter and field employees and ULB Administrators to accomplish their specific tasks. It is available as a mobile and web-based application. The PT product features can be broadly classified as the following modules:
Registration, Login and Creation of User Profile
Filling an Assessment for a Property
Searching for a Property
Modifications to a Property
Generate Demand Notice
Payments collection and Receipts
Dashboards and Reports
General Features
This module provides enables the following capabilities
OTP Based Login for Citizens via Web/Mobile App
OTP Based Login for Employees via Web/Mobile App
Provision for language selection during first-time registration for both Employees and citizens
Provision of creating a personalized Profile for Citizens and employees on the Web App
Login Credentials for various hierarchies of employees
Role-based access for performing different actions relating to property tax modules
With this feature, a citizen and employee can perform a self-assessment of a new property for a financial year. This feature helps in registering the property in the system. The details of the property can be entered online and can be assessed for the calculation of the taxes. The PT Product is designed in a user-friendly manner and reduces the chances of error. The system calculates the tax automatically and creates the demand. If a user wants to reassess his property due to any reason (for eg, incorrect data, change in property etc), it can be done by editing the details of the last assessment. Employees can edit the details of the last assessment, on behalf of the citizen based on the owner’s input. A citizen can track down the status of the incomplete assessment. Any incomplete assessment can be searched and completed.
This module provides enables the following capabilities:
Citizen/CSC can Assess New Property (By Different Financial Years).
Citizen/CSC can capture Addresses, Assessment, and Owner information for all types of properties like residential houses, flats and commercial buildings.
Sample Details captured:
Door Number,
Mutation number,
Number of floors,
Area covered,
Owner and co-owner,
Mailing & permanent address,
Built year
Individual room measurements
The system computes the property taxes automatically as per the process and rules of the state.
The system has a facility to make entries in the system by inspector after a site visit and assessment of the same by the superintendent.
The system supports the dynamic calculation for late fees, interest, rebates, etc. as on the day of demand generation.
The system fetches the data of the previous year's property data while e-filing for the current year so that all the dues are calculated.
The system assigns a unique property ID based on the process defined in the ULBs.
Citizen/CSC: View/Print Summary of Filled Form
Assessment Form
The assessment form is also sent by email to citizen
Upload Documents
Ownership/Title related
ID Proof
Any other statutory documents
Citizens or Employees can track down the status of their incomplete assessment. Any incomplete assessment can be searched and completed.
This module provides the following capabilities:
Citizens/CSC can search for Property by
Mobile No,
City,
Property Tax Unique ID
Citizens/ CSC can view Incomplete Assessments
Citizen/CSC can reassess Searched Property
View Property Details and pending dues
The PT system provides the ability to capture mutation and transfer of ownership. It reduces interfaces between the user and the State and thus promotes greater transparency. It also helps in reducing the time taken for mutation after registration. The system provides the ability for alteration of assessment after verification and inspection.
Any structural changes like addition/extension/reduction of existing built-up area or construction type OR utility changes like usage or occupancy have an impact on the increase/decrease in a property tax demand. These changes can be handled by the ‘Additional/Alteration of Assessment’ feature. The System provides the ability for bifurcation/ amalgamation of property. The property bifurcation/ amalgamation undergoes an approval process. The parent property needs to be modified accordingly, which can be done in the system.
This module provides the following capabilities:
Mutation of property and change of ownership details
Capture Extension/ Addition and Alteration and reassessment based on changed property details
Bifurcation of property
Amalgamation of property
The system has the capability to automatically generate demand notices for a financial year based on set triggers like time-based rollover on completion of a financial year. The system notifies the citizens about the demand through SMS/Email. The generated Bills can also be grouped and printed for physical distribution by the ULB employees. The system provides the capability for Employees to merge and download bills based on given parameters to plan their distribution drives.
This module provides the following capabilities:
Generate Demand Notice based on a periodic basis
Group Demand Notices
Print Demand Notices
Cancel Demand Notices
Send notifications to citizens on demand generation- SMS, Whatsapp, Email, Physical bill
The citizen/ employee can view the payment status of previous assessments from the Assessment History section. Payment for any assessment with full or partially paid amount can be completed. Receipts for assessment can be downloaded in the Assessment history section after searching for the property details.
This module provides the following capabilities:
Payment of Property Tax -Online, Cheque, Cash, DD, during the assessment
Partial Payment of Property Tax -Online, Cheque, Cash, DD, during the assessment
The system allows a citizen to pay for anyone's property without changing the demand
The system can also be integrated with PoS machines to enable doorstep collection of property tax and the issue of a receipt.
PT reports provide the facility to access the receipt register, cancelled receipt register, account receipt register, ULB-wise PT collection report, and DCB Register. All reports can be downloaded in PDF/XLS format. State-level administrators can monitor property tax collections, assessments and other information at a state level through dashboards.
This module provides the following capabilities:
State Dashboard: View Reports for Total Collections, Properties Assessed, ULBs on Prod, Usage Type, Payment Distribution
State Dashboard: PT Collection Timeline (Monthly, Weekly)
State Dashboard: ULB Wise (Collection, Assessments)
Cancelled Receipt Register Report
PT Collection Report (ULB/Date Wise)
The system has the capability to send notifications to citizens. These notifications can be sent for various steps like - assessment completion, payment reminder, and payment confirmation. These notifications can be sent in the language chosen by the ULB through all channels - SMS, Whatsapp, and Email.
The system has the capability to migrate Demand and Collection. In most states, the preliminary step would be to migrate Legacy data of existing properties/connections along with the Demand and Collection details. This would ensure that subsequent demand generation happens through the system.
The system provides the following masters that can be configured as per the State’s requirements:
Charges & Calculation: Calculation Engine, Rebate, Penalty,
Rate Master
State Masters: Property Ontology, Documents List, Employee Data Mapping, Boundary Data Mapping
This section provides an overview of the methodology for State-wide implementation of PT. The Implementation of PT is distributed across seven distinct stages. Each stage has predefined entry & exit criteria and roles & responsibilities. This is to ensure objective monitoring and decision-making for the overall success of the program. Details of each stage are defined in this section.
Note: This document is specific for States that have more than 30 ULBs
PT implementation program is expected to be completed approximately between 38- 42 weeks depending on the variety of Processes, Integration and the Disparate legacy data systems involved. This is done with the resource deployment by the State and System Integrator (SI) Team. However, it is critical that activities and exit criteria set for each stage are achieved to adhere to this timeline.
This is a set of initial critical activities undertaken on receiving a letter of Enrollment or MOU from the State. Successful completion of these activities assures that the program is started with crucial personnel, System Integrator(SI) Teams, and funds.
*Details of PT cell is mentioned in section 4 of this handbook
System Integrator and state will agree on program scope, program timelines, and budgeting & resourcing.
This stage envisages in-person interaction of crucial State officials and implementation System Integrator(SI) Teams to kick-start the program. This stage may require multiple interactions/meetings with different interest groups. The principal objective of these interactions is to identify and agree on the scope and exclusions of Pilot ULBs, create an active collaboration & Governance approach and agree on a high-level timeline for the engagement.
*Details of PT cell is mentioned in section 4 of this handbook
During the Solution design stage, key State officials and members, who are subject matter experts, are expected to share their inputs, discuss the process and help understand how to bring in compliance around the system design for the System Integrator(SI) Team. This stage baselines the State-specific product features in the Product Configuration report.
This stage consists of a series of developments in accordance with the detailed project plan to ensure the smooth functioning of the customised product. Master Data Collection & Environment Setup will be achieved in this phase. Further monitoring and maintenance strategies are put in place.
During this stage, a demonstration of the product followed by a hands-on session is conducted for the ULB officials. Necessary training of ULB officials and resources required for UAT is conducted and identified respectively. The establishment of the State Support Team and required processes are initiated in this stage.
On successful Go-Live in the Pilot ULBs, and further fine-tuning to stabilize the product, the solution will be rolled out to the rest of the ULBs in phases. Guidance and support from the State Team will be required to create the rollout plans and assure the necessary infrastructure for training and deployment is available at each ULB.
Note: The rollout phase needs to be detailed out for iterative activities of onboarding ULBs in batches.
Note: Only once all the stages are complete in one batch of the rollout of around 30 ULBs, the next batch begins. There are multiple phases of rollout. The second batch begins after the first batch has successfully fulfilled all the criteria of the Rollout Phase. A typical timeline for the closure of rollout in each batch is 5-6 weeks (in a batch of 30 ULBs)
The final stage consists of strategies to ensure the sustenance of the program in the State. Systems are put in place to ensure the continuous tracking of data and provisions are made to improve the product if new data suggest.
This section outlines the activities involved in each stage of the implementation along with the responsibility and accountability of critical stakeholders - State, eGov Team and System Integrator Team onboard.
PT Cell: PT Cell is the government-appointed body chaired by the Principal Secretary/Secretary, Urban Development Department with members from Urban Development Department etc.
Resource requirements for the PT cell required to be formed by the State
Note:
The designations mentioned above are in accordance with those already driving PT implementation at the State level.
The description of each designation is explained below.
Project Head: Is the Head of the PT Cell who will drive the project from the State’s Side
Domain Expert: A person who is well aware of the on-ground scenario, well versed with the act, GOs passed, Prevalent Business processes, Deviations from the acts, and PT Rates/ slabs applicable. In addition, provisions may be made to include External Domain Consultants/Advisors.
Nodal officer (EO/Commissioner/ Senior Official): the product coordinator to drive the project centrally. Monitor usage post Go Live- point of escalation for Implementation Team, Seasoned and worked in Multiple ULBs on various modules and has a good understanding of PT, Facilitates and Tracks data collection Post Go Live, Monitors and facilitates the adoption of the application. Point of contact for the Management team, SI and at the HQ level.
MIS Expert: Data Preparation for ULBs, Day to day tracking of the data specific to ULBs, data collection/validation for correctness and comprehensiveness, reporting and review to senior officials
eGOv Team: eGov Team is the technical partner of the project which will provide all necessary support to the State/UT concerning the implementation, Program Designing etc.
System Integrator (SI)Team: SI Team will be responsible for consulting, program management and the implementation of the state-specific customized and configured products in the ULBs in close collaboration with the PT cell, technical partner (eGov) and various other stakeholders.
Execute - One who owns the accountability to complete the activity
Consult - One who may initiate, guide and in the process, handhold the execution of the activity
Note: Stage 0 is where the PT cell and SI team is formed, hence there are only two entities playing a role which are that of eGov and the state leadership.
Once the PT cell and SI team are finalised, their role begins in the following stages.
Vision: Defining the time frame to go live, the time frame to scale it pan state, the value proposition of the programme for the state and year-on-year financial targets and adoption targets
Project Plan: A detailed plan of Program schedule/timelines, implementation phases, team structure and ongoing support and maintenance required.
System Integrator: The Entity/Company which collates all the subsystem required for the project and integrates them to achieve the program objective
Program Charter: Outline of implementation plan agreement with priority applications and broad timelines, program governance model, program success metrics and capacity building.
Acceptance Letter/MOU: Formal Acceptance/Sign Off of the Client State with a clear mandate of the Program
Program Success Metrics: Defining the parameters (which are measurable) prior to the program, on which the success of the program is to be measured on the completion of the program
Project steering committee: The key body within the governance structure which is responsible for the business issues associated with the project that are essential in ensuring the delivery of the project outputs and the attainment of project outcomes.
Project governance: Set of policies, regulations, functions, processes, procedures and responsibilities that define the establishment, management and control of projects, programmes and portfolios.
Scoping: List of activities measured against the time taken to complete them in accordance with the project goals
Baseline data: Set of information that serves as a foundation to compare other data acquired afterwards
Project Kick-off meeting: Meeting with the project team and the client of the project. This meeting would follow the definition of the base elements for the project and other project planning activities
Fitment Study: GAP Study of the Existing/Required Field Process Vs Product
Data migration: Existing Records of the functional activities need to be moved into the Database of the newly released Application
Data collection: Required data for the roll-out of the applications, which needs to be collected from the existing functional process
Data validation approach: This approach enables the sanctity of the Data with built-in validation by the Design
Data synchronization: The process of establishing consistency among data from a source to a target data storage and vice versa and the continuous harmonization of the data over time.
Pilot Implementation: Any new process is tested out as a pilot in one or two instances before pan implementation
Pilot ULB: The ULBs Selected for the pilot implementation are called pilot ULBs.
Roll out: On successful clearance of the Pilot, the Process/Application/Services are implemented across all Offices/ULBs
Deployment: Deployment defines the complete package of Software components set up in a particular environment
Customisation: Details of changes to be made in the Product to comply with the needed field process
Configuration: Defining existing content such as Options and Variables based on the requirements on the ground
Product walkthrough: Explaining to the users step-by-step a set of actions that they need to take to achieve a specific outcome
The Owner’s Special Category represents those property owners whose property belongs to the “reserved” category as defined by the state. These special categories are entitled to a rebate in the property tax amount, as per the defined categories by a State/ ULB.
The data given in the table is sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Identify the “Owner Categories” that exists at a ULB/ State level.
Add the “Owner Type Code” respectively.
Add a description to the Owner Type Name, as per the required language.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
In order to justify the Property Owner’s Special Category status, there are certain supporting documents that are required as the attachment of proof. These documents are crucial in terms of providing/ availing rebate on the property tax amount.
The data given in the table is sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Identify the “Owner Categories” that exists at a ULB/ State level.
Add the “Owner Type Code” respectively. The predefined format of the Owner Type Code only must be used from the “Owner Special Category” Master Sheet and not any random code. This will provide the base reference for the mapping of ownership type with the required documents.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
Unit rates are also an important part of property tax. The property tax for a property is calculated on the area covered by the property. These unit rates could differ from ULB to ULB, Ward to Ward, Mohalla to Mohalla and then can be based on different parameters such as Road Type, Property Construction Type etc.
The data given in the table is sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Figure out on what boundary types are the property tax unit rates being defined and start filling that with its code and its name in English in the boundary code and boundary code name column.
In case there are more parameters on which the unit rates are being classified such as road type, construction type is being classified, start making a different column for the same starting from parameter 1, parameter 2…
Make sure you replace the column name from parameter 1 to the classification on which it is being classified.
At the end fill up the unit rates column.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
The Usage category could be more detailed out on classifying them further and detailing more specifically on what kind of usage it is such as hotel, shops, community centre etc.
Below mentioned is the definition of the template which is used in data gathering:
The data given in the table is sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Gather all the details for this last classification of Usage Category Detail.
Figure out the codes, if not present abbreviate the description so that it creates relevancy between code and description.
Get the relations to the sub minor, minor and major.
Start filling the template with the codes and description of the usage Category detail and then followed by relative sub minor codes.
In the active column fill up whether the category is still active or not.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed on the data that is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
Taxes are calculated based on the type of property and differ for each type.
For example, a residential property could have a different rate than a non-residential property, which could differ from year to year.
The tax could be a general property tax or a new type of tax introduced.
The data given in the table is sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Gather the details for all the types of properties and the type of taxes levied on them.
Start filling the type of tax and the property type from the first column and then start defining the rates and year of application.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
Ownership is the state or fact of exclusive rights and control over property, which may be an asset, including an object, land or real estate, or intellectual property. Ownership involves multiple rights, collectively referred to as title, which may be separated and held by different parties. Further, the ownership can be categorised based on the nature and type of the parties property is owned by e.g Property owned by an individual who is the resident of the city, by an institution etc.
Given below is the sample data table from the template in which the data has to be collected:
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Firstly Identify all the categories of the owners present in the state.
After which identify the codes of all the categories, if not present then form an abbreviated version of the code.
Start filling the template with the codes in the second column, its English name in 3rd and Local Language name in 4th.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
This is a further sub-classification of the ownership which details what is the ownership sub category, whether there is a single owner, multiple owner etc. . An example has been given in the attachments section of the page.
The data has to be collected for all the subcategories of ownership type present in the state. Below mentioned is the table of the template that is being used to gather data:
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts. First, get all the sub classifications for the listed category.
Get the codes and start filling the template.
Fill in the codes for the sub category in the 2nd column with the proper mapping of Ownership Type category (Parent level).
Repeat the steps for all the ownership type categories(Parent Level).
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
This checklist covers the activities which are specific to the entity.
Reform No. | Reform Area | Weightage (score) | Recommendation | Remarks |
---|---|---|---|---|
Stage 1 - Program kick-off | |
---|---|
Resource Name | No. Of Resources |
---|---|
Stage 0 - Program Setup/ On-Boarding | ||
---|---|---|
Stage 1 - Program kick-off | |||
---|---|---|---|
Stage 2 - Solution Design | |||
---|---|---|---|
Stage 3 – Configuration & Customization | |||
---|---|---|---|
Stage 4 – UAT & Go Live | |||
---|---|---|---|
Stage 5: Rollout | |||
---|---|---|---|
Stage 6- Sustenance and Ongoing Improvement | |||
---|---|---|---|
Areas | Assumptions |
---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Owner Type Code* | Owner Type Name (English)* | Owner Type Name (Local Language)* |
---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Owner Type Code* | Ownership Documents Description (English)* | Ownership Documents Description (Local Language)* |
---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Boundary Code* | Boundary Name* | Parameter 1* | Parameter 2 | Unit Rate* |
---|---|---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr.No. | Usage Category Detail Code* | Usage Category Sub Minor Code* | Usage Category Detail (In English)* | Usage Category Detail (In Local Language)* | Effective From Financial Year* |
---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No. | Tax Head* | EffectiveFromFY* | Percentage* |
---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No | Ownership Category Code* | Ownership Category* (In English) | Ownership Category* (In Local Language) |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No | Ownership Sub Category Code* | Ownership Category Code* | Ownership Sub Category* (In English) | Ownership Sub Category* (In Local Language) |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
7
Land administration and Transfer of Land and Property
3
Digitize land transaction deeds of last 10 years at all sub-registrar offices and make the same available on an online system to check for ownership details and history. The metadata should be searchable for each record and a soft copy of the registered deed should be available. The searchable metadata available should be:
i. Name of buyer
ii. Name of seller
iii. Survey no.
iv. Registration number
v. Registration date
The feature of ‘Property Registry’ in the product will enable this recommendation
8
Land administration and Transfer of Land and Property
3
Digitize and publish the updated Record of Rights (ROR) at all Revenue department offices online in public domain for all areas of the State/UT. The searchable metadata available should be:
i. Name of buyer
ii. Name of seller
iii. Date of mutation
iv. Survey no.
The Property tax system enables this capability
9
Land administration and Transfer of Land and Property
2
Digitize and publish data of Property Tax payment dues online in public domain for all the Urban Local Bodies (ULBs) in the State/UT. The searchable metadata available should be:
i. Name of the Property Tax payer
ii. Property Tax dues
iii. Survey no. of land / Unique Identification no. of property
This feature is enabled by the citizens itself
10
Land administration and Transfer of Land and Property
2
Digitize cadastral maps of all rural areas in the State/UT and make them available in public domain
This can be enabled and worked on by the state team
11
Land administration and Transfer of Land and Property
5
Integrate the below-mentioned records on one website:
i. Data of land transaction deeds for last 10 years at all sub-registrar offices (Name of buyer, Name of seller, Registration number, Registration date, Survey no.),
ii. Updated Record of Rights at all Revenue department offices (Date of mutation), and
iii. Data of Property Tax payment dues at all urban areas of the State/UT (Name of the Property Tax payer, Property Tax dues)
iv. Revenue Court case data (Court case number, Name of parties involved, Date of filing of court case, Status of case [Ongoing/Resolved])
v. Civil Court case data (Court case number, Name of parties involved, Date of filing of court case, Status of case [Ongoing/Resolved])
The website should be publicly accessible. It will help in establishing property ownership and identify tax encumbrances. The integration should be done for all areas of the State/UT.
The integration with external portals and systems of other departments can be enabled by state teams who can enhance the offered product to cater to this recommendation
12
Land administration and Transfer of Land and Property
2
Implement an online application system having the following features
i. Mandatory Online application submission including submission of draft deed and other documents
ii. Provision of online payment of Stamp duty and Registration fee
iii. Auto generation of appointment date and time on making the payment of Stamp duty and Registration fee
The system will provide these capabilities which can be customized as per the state specific rules and regulations
13
Land administration and Transfer of Land and Property
1
Provide model deed templates for sale, gift, lease, mortgage and rent in downloadable and editable format along with instructions to use them
This provision is made available through the ULB portal to make these features accessible to the citizens
14
Land administration and Transfer of Land and Property
2
Integrate the mutation process with the registration process and mandate initiation of mutation process (Revenue department and/ or ULB) as soon as the deed is registered. Ensure that:
i. Information to mutation authority to be automatically shared on completion of transaction (registration). This should be considered as initiation of mutation process.
ii. No separate application from transferee to be required.
iii. SMS/email should be sent to transferee/ transferor to inform about the initiation of mutation
The integration with external portals and systems of other departments can be enabled by state teams who can enhance the offered product to cater to this recommendation
Stage 0 - Program Setup/ On-Boarding
Duration
4-6 weeks
Entry Criteria
Acceptance Letter/MoU by State
Exit Criteria
Finalize Property Tax Program Vision
Finalize funding for the program
Define State- specific procurement process
Property Tax Cell appointment (*). Consisting of :
Domain expert
Nodal officer (EO/ Commissioner/ Senior Official)
Program Head
System Integrator(SI) Team sign-up/onboarding
Duration
4-6 weeks
Entry Criteria
Program setup (Stage 0) is complete
SI Team onboarded
Key Activities
Identify & agree on scope and exclusions
Identify pilot ULBs
Project Kickoff - Implementation Methodology Presentation
Product Walkthroughs
Define Project Steering Committee Structure and Project Governance process
Define phases of rollout/ deployment
Agreement on Deployment Priorities and high-level delivery timelines
Assessment of all current PT processes along
(1) Citizen services/channels around it
(2) Integration with other Department process
Finalise Program Success Metrics for Rollout, Adoption and Governance, adhering to the vision of the program
Internal Capacity Building, program logistics at State and ULBs, as per the current scenario
Collection of baseline data to measure endline target for the product (Revenue generated, total properties in ULBs etc.)
Exit Criteria
Publish the program charter
Implementation plan agreement with priority applications and broad timelines
Program Governance Model and processes
Program Success Metrics
Capacity Building
PT Cell formation and appointment (*)
Data preparation/collection kickoff from Pilot ULBs
Cloud Infrastructure procured
Project Office Space allocated
Program Branding (name, logo, tagline etc.)
Stage 2 - Solution Design
Duration
4-6 weeks
Entry Criteria
Program Charter
PT Cell appointment
Key Activities
Standardisation of all PT processes
Initiate policy change if needed, based on the Processes defined
Conduct Product familiarisation workshop
Initiate collection of master data from pilot ULBs
Finalise data migration/collection/sync-up approach
Finalise data validation approach
Capacity Building for making state team aware about basic usage of tools like MS Office, mails etc.
Dashboard design finalisation for Program Tracking
Exit Criteria
Publish the PT processes, data template/workflows
Finalisation of Roll-out plan (in different phases)
Solution agreement for required State- specific customisations
Program tracking mechanism (Dashboard design finalisation)
Sign-off on approach to work with legacy or manual data (Data collection/migration/correction/ sync-up/validation)
Detailed project plan
Stage 3 – Configuration & Customization
Duration
6-8 weeks
Entry Criteria
Product Configuration Report has been signed off by the state
Detailed Project Plan set up in accordance with master data collection and environment setup
Key Activities
Setting up development environments
Development/customisation of reports and dashboards
Development/ integration of portal
Third-Party integrations (payment gateway, handheld/pos device)
Updation of user manuals and other key documents
Preparation & execution of Test Cases
Setup monitoring, support & maintenance processes, tools and dashboards
PT legacy data collection from Pilot ULBs(at least). No historical transaction will be considered. Only outstanding and property details shall be migrated
Capacity Building for making state team aware about basic usage of tools like MS Office, mails etc.
Identify ULB level Nodal officers for day to day support
Migration and verification of Pilot ULB data
Exit Criteria
Configured/Customized product that is ready for UAT
Monitoring, support & maintenance of Dashboards
Finalization of Initial Reporting and Dashboard KPIs
Identification of participants for UAT session
Training for System Content related Capacity Building finalised
Stage 4 – UAT & Go Live
Duration
2-3 weeks
Entry Criteria
Configured/Customized product ready for UAT
Pilot ULB Officials associated with TL are available for UAT & Training
Key Activities
UAT Environment Setup
Regression UAT and sign off from Pilot ULBs/ State
Issues/bug resolution
Setting up the Production environment
Setting up Support Center & processes (Help Desk)
Training (Users, trainer)
master trainers identified from ground for simultaneous training
Training the support resources
Marketing & promotion activities
Go Live & launch event
Setup of review and monitoring cadence/team
Usage/review/Dashboard/Field Visits
Exit Criteria
UAT Sign-off & Go Live for Pilot ULBs
Setup of review and monitoring cadence
Stage 5 – Rollout
Duration
5-6 weeks
Entry Criteria
Pilot has been successful in the State
there are less than 3 open critical incidents (issues) with respect to product, implementation and data
Key Activities
ULB configurations phase wise as per the Project Plan
Migration and verification of ULB data
Logistics planning for training
Establishment of bug ticketing tool for resolving ground level issues by the state team
Training the Users at the district level
Pan State Roll Out - Phase wise
Stabilise product
Exit Criteria
State-wide Rollout in batches:
Adoption tracking & Review Cadence operational
Help Desk Effectiveness assured
Critical Bugs fixed
Program Success Metrics Tracking Kick-started
Stage 6- Sustenance and Ongoing Improvement
Duration
Ongoing process
Entry Criteria
Rollout Phase 1 (First set of 30 ULBs where rollout will happen after all ULBs are live)
Key Ongoing Activities
Adoption Review Meetings as per the vision defined for the program
Plans for Execution of Core Team to ensure Sustenance of the initiative in the areas of:
Funding
IT support (infra, helpdesk, ongoing enhancements)
Process Effectiveness and Improvements
PT Cell Focuses on Using data for:
tracking field issues and performance data to identify improvements
identify additional Integrations around PT to make processes more robust towards enhancing PT revenues (e.g Upstream and downstream Processes)
Project Head
1
Domain Expert
1 Representation from Corporations/Council/Panchayat etc.
District Nodal Officer
1 per district
MIS Expert
1 per district
Task/Activity
eGov
State Leadership
Appoint PT Cell
Consult
Execute
Finalise funding for the program
Consult
Execute
Define state -specific procurement process
Consult
Execute
System Integrator(SI) Team sign-up/onboarding
Consult
Execute
Finalise Property Tax Program Vision
Consult
Execute
Task/Activity
eGov
PT Cell
SI Team
Identify & agree on scope and exclusions
Consult
Consult
Execute
Identify pilot ULBs
Execute
Consult
Project Kickoff - Implementation Methodology Presentation
Consult
Consult
Execute
Product Walkthroughs
Consult
Execute
Define Project Steering Committee structure and Project Governance process
Consult
Consult
Execute
Define phases of deployment/ rollout
Consult
Execute
Agreement on Deployment Priorities and high-level delivery timelines
Consult
Execute
Assessment of all PT process along
(1) citizen services/channels around it
(2) Integration with other department process
Consult
Execute
Finalize Program Success Metrics for Adoption and Governance adhering to the vision of the program
Consult
Consult
Execute
Internal Capacity Building, program logistics at State and ULBs, as per the current scenario
Execute
Consult
Collection of baseline data to measure endline target for the product (Revenue generated, total properties in ULBs etc.)
Consult
Execute
Consult
Task/Activity
eGov
PT Cell
SI Team
Standardisation of all PT processes, if needed
Consult
Execute
Initiate policy change, if needed based on identified improvements
Consult
Execute
Consult
Conduct Product familiarisation workshop
Consult
Execute
Initiate collection of master data from pilot ULBs
Consult
Execute
Finalise data migration/collection/sync-up approach
Consult
Execute
Finalise data validation approach
Execute
Consult
Capacity Building for making state team aware about basic usage of tools like MS Office, mails etc.
Execute
Consult
Task/Activity
eGov
PT Cell
SI Team
Setting up development environments
Consult
Execute
Development/customisation of reports and dashboards
Consult
Execute
Development/Integration of portal
Consult
Execute
Third-Party Integrations (Payment gateway, Handheld/pos device)
Consult
Execute
Updation of user manuals and other key documents
Consult
Execute
Preparation & execution of Test Cases
Consult
Execute
Setup monitoring, support & maintenance processes, tools and dashboards
Consult
Execute
PT legacy data collection from Pilot ULBs(at least)
Consult
Execute
Capacity Building for making state team aware about basic usage of tools like MS Office, mails etc.
Execute
Consult
Migration and verification of Pilot ULB data
Consult
Execute
Task/Activity
eGov
PT Cell
SI Team
UAT Environment Setup
Consult
Consult
Execute
Identification of participants for UAT session
Consult
Execute
Issues/bug resolution
Consult
Execute
Regression UAT and sign off from Pilot ULBs/ State
Execute
Consult
Setting up the Production environment
Consult
Execute
Setting up Support Center & processes (Help Desk)
Execute
Consult
Training user
Execute
Consult
Training Trainer
Consult
Execute
Training the Support Resources
Consult
Execute
Marketing & promotion activities
Execute
Consult
Go Live & launch event
Consult
Execute
Execute
Setup of review and monitoring cadence/team
Execute
Consult
Task/Activity
eGov
PT Cell
SI Team
ULB configurations phase wise as per the Project Plan
Consult
Execute
Migration and verification of ULB data
Execute
Consult
Logistics planning for training
Execute
Consult
Establishment of bug ticketing tool for resolving ground level issues by the state team
Consult
Execute
Training the Users at the district level
Execute
Consult
Pan State Roll Out - All Locations
Consult
Execute
Execute
Stabilise product
Consult
Execute
Task/Activity
eGov
PT Cell
SI Team
Adoption Review Meetings as per the vision defined for the program
Consult
Execute
Consult
PT Cell Focuses on Using data for:
tracking field issues and performance data to identify improvements
identify additional Integrations around PT to make processes more robust towards enhancing PT revenues (e.g Upstream and downstream Processes)
Execute
Consult
Plans of ongoing Sustenance in Place with respect to :
Funding
IT support (infra, helpdesk, ongoing enhancements)
Process Effectiveness and Improvements
Consult
Execute
Consult
Infrastructure
The actual Infra will be provided based on the questionnaire inputs received from the state
The state will take care of providing necessary project infrastructure and office facilities during the program for all on-site project Team members, which will be confirmed during the initiation phase. This includes workspace, office equipment (e.g., telephone with STD, fax machine, photocopy machine, etc.), stationery, PC/workstation, project LAN and internet access, etc.
The state will provide the necessary administrative support staff to carry out day-to-day project administration tasks, e.g., meeting rooms, Videoconferencing, etc.
The state should provide a Project Office and at least one conference room with speakerphone throughout the Project Duration.
Project Scope
Any new requirements received from State during the implementation phase will be handled through a change management process
State Team
The state will nominate a reasonably sized multifunctional Team from various departments of the State to be responsible for the implementation. The state Team would be required for information, validation, and execution through the implementation cycle and the Team members should be reasonably empowered to take decisions. Any delay in the decision-making process and the non-availability of the State Team may have an impact on the schedule.
The participants from State are expected to have a thorough understanding of the State’s internal processes.
The state will engage internal and external stakeholders required for this engagement and ensure their availability whenever needed.
Documentation
The Tech Implementation Partner will ensure provision of the following:
User education and training documentation delivery as per the default product documentation of the identified product versions.
Product manuals are expected to be shared with the State as part of the user manual.
All documentation in English and the language requirement of the state.
Training
Training to the end-users will be driven by the state Team.
The state will be responsible for providing the necessary infrastructure required for the Training, which includes the following readiness.
Training Rooms (Parallel Training Sessions) with Projector, White Board, Markers, Internet Connection, sufficient seating capacity, Desktop/Laptop for each participant and availability of Network for Trainees to connect to the server.
Implementation
The scope of the implementation will be limited to the services mentioned in Section 2.
State Team will have an identified SPOC for handling the first level of eGov communication with the client unless discussed and agreed.
eGov Team will not be involved in defining the test cases or executing the test cases.
Necessary signoff would be provided by the state upon completion of the defined milestones.
1
FREEDOMFIGHTER
Freedom Fighter
स्वतंत्रता सेनानी
2
WIDOW
Widow
विधवा
3
HANDICAPPED
Handicapped Persons
विकलांग व्यक्ति
1
Owner Type Code
Alphanumeric
64
Yes
Unique Identifier for Owner Type
2
Owner Type Name ( In English)
Text
256
Yes
Nomenclature of “Owner Type” in English
3
Owner Type Name (In Local Language)
Text
256
Yes
Nomenclature of “Owner Type” in the local language as Telugu, Hindi, etc.
1
Make sure that each and every point in this reference list has been taken care of
1
The predefined format of the Owner Type Code only must be used and not any random code
-
1
FREEDOMFIGHTER
Certificate issued by DC/ Competent Authority
डीसी / सक्षम प्राधिकारी द्वारा जारी प्रमाण पत्र
2
WIDOW
Death Certificate + Spouse proof
डेथ सर्टिफ़िकेट + जीवनसाथी प्रमाण
3
HANDICAPPED
Certificate of Handicap by a competent authority
सक्षम प्राधिकारी द्वारा विकलांग का प्रमाण पत्र
1
Owner Type Code
Reference
64
Yes
Unique Identifier assigned for the Owner Type. For example, Freedom Fighter is represented as FREEDOMFIGHTER
2
Ownership Documents Description (English)
Text
256
Yes
Nomenclature of “Owner Documents” in English. For ownership type Freedom Fighter, the document required is the certificate issued by DC/ Competent Authority
3
Ownership Documents Description (Local Language)*
Text
256
Yes
Nomenclature of “Owner Documents” in Hindi
1
Make sure that each and every point in this reference list has been taken care of
1
The format of the Owner Type Code defined should be Text
War Widow is represented as WIDOW
2
Owner Type Code should not contain any special characters
WIDOW: [Allowed]
#WIDOW! : [Not allowed]
1
M001
Haldwani Mandir
PUCCA
< 12 m
1.50
2
M001
Haldwani Mandir
SEMIPUCCA
>= 12 m and <= 24 m
1.75
3
M001
Haldwani Mandir
KUCCHA
> 24 m
2.00
4
M002
Kali Mata Mandir Road
SEMIPUCCA
< 12 m
3.00
5
M002
Kali Mata Mandir Road
SEMIPUCCA
>= 12 m and <= 24 m
10.00
6
M002
Kali Mata Mandir Road
SEMIPUCCA
> 24 m
20.00
1
Boundary Code
Alphanumeric
64
Yes
The code of the boundary that is being used, depending upon the client's requirement it could be Mohalla or Ward but has to be from the data collected here
2
Boundary Name (In English)
Text
256
Yes
The name/description of the boundary that is being used for the classification. The names have to be from the data collected here
3
Parameter 1
Alphanumeric
64
Yes
This has to be the parameter 1 code on the basis of which the unit rates are being defined
4
Parameter 2
Alphanumeric
64
No
This is the second parameter(if available) on the basis of which the unit rates are being defined
5
Unit rates
Decimal
(5,2)
Yes
The unit rate
1
Make sure that each and every point in this reference list has been taken care of
1. | RED | RESIDENTIAL | | आवासीय | 2019-20 |
2. | NONRED | HOTELS | | होटल पेईग गेस्ट हाउस 10 कमरों तक(बेगैर वातानुकूलित) | 2018-19 |
1 | General Tax (Residential) | 2019-20 | 10 |
2 | General Tax (Non-residential) | 2019-20 | 9 |
1 | Tax Head | Alphanumeric | 64 | Yes | The type of tax and the property on which the tax is being levied |
2 | EffectiveFromFY | Numeric | (12,2) | Yes | The year from which the tax rate is being defined |
3 | Percentage | Numeric | (12,2) | Yes | The rate at which the tax is to be levied |
1 | INDIVIDUAL | Individual | व्यक्तिगत |
2 | COMPANY | Company | कंपनिगत |
3 | SOCIETY | Society | सहकारी समिति |
1 | Ownership Category Code | Alphanumeric | 64 | Yes | Code to uniquely identify the ownership category record |
2 | Ownership Category (In English) | Text | 256 | Yes | This is the name of the ownership category in the English language |
3 | Ownership Category (In Local Language) | Text | 256 | Yes | This is the name of the ownership category in the local language |
1. | SO | INDIVIDUAL | Single Owner | एकल स्वामी |
2. | MO | INDIVIDUAL | Multiple Owner | मल्टीपल ओनर |
1 | There should be a mapping code between the sub category (child) and Property Tax: Ownership Category (parent level), no child can be left without a parent | - |
2 | Make sure that no code which is not mentioned in the ownership category classification (parent) can be used | - |
1 | Usage Category Detail Code | Alphanumeric | 64 | Yes | This column ideally contains the code for which the Usage Category Detail is being categorized |
2 | Usage Category Sub Minor Code | Alphanumeric | 64 | Yes |
3 | Usage Category Detail Description (English) | Text | 256 | Yes | Description/ Detail of the detail code in which the category is being classified in the English Language |
4 | Usage Category Detail Description (Local Language) | Text | 256 | No | Description/ Detail of the detail code in which the category is being classified in Local Language. e.g. Hindi, Telugu etc. |
5 | Effective From Financial Year | Numeric | (12,2) | Yes | This is the year from which the category detail has come into effect for property tax |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Ownership Sub Category Code | Alphanumeric | 64 | Yes | This is the code that is being used to categorize the sub type |
2 | Ownership Category Code | Alphanumeric | 64 | Yes |
3 | Ownership Sub Category (In English) | Text | 256 | Yes | Description of the ownership Sub type in the English Language |
4 | Ownership Sub Category (In Local Language) | Text | 256 | Yes | Description of the ownership Sub type in Native Language |
1 | Make sure that each and every point in this reference list has been taken care of |
The first level of classification of a property based on its construction is defined as Property Type. Generally, the property is divided into two types :
Built-up
Vacant Land
Mostly these property types are fixed and commonly used in all the ULBs across the country. Hence this data is not needed anymore in the template.
The data provided in the above table is sample.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Identify the “Property Types” that exists at a ULB/ State level.
Collect the above information and feed it below the “Property Type Description” column accordingly. The Description of Property Type must be provided as per the language specified in the respective column.
Add the “Property Type Code” respectively against the identified Property Type(s).
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
There is no separate checklist applicable to this entity.
Roads are constructed in order to facilitate the locomotion of people from a place to another.
The roads constructed in a state are classified into certain categories which could be on the basis of the width of the road, construction material or the function and location. Road type is one of the primary factor defining the unit rates and hence configuration is needed for the DIGIT module in order to describe the property and what are the taxes it could attract.
Given below is the sample data table from the template in which the data has to be collected:
Please note that the values mentioned in the data table are sample values and the states are free to add/update according to their specific requirements.
The data described in the above table is sample.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to understand the headers in the template sheet, their data type, size, and definitions.
Reach out to the person who shared the template for further details or to clear your doubts. Identify if the State/ULB has a provision for capturing pipe size for connections.
Identify all the property sub types applicable and fill into the given template.
Go through the checklist to verify the data. Make sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
There is no separate checklist is applicable to this entity.
A property can be used for a variety of things such as to live or to do some trading/selling etc activity or for any other purpose. Properties can be classified into various categories on the basis of its usage. Ideally, property usage is categorized as residential, non-residential or a mix of both.
The data described in the above table is sample.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to understand the headers in the template sheet, their data type, size, and definitions.
Reach out to the person who shared the template for further details or to clear your doubts. Identify if the State/ULB has a provision for capturing pipe size for connections.
Identify all the property usages categorized at the first level and fill into the given template.
Go through the checklist to verify the data. Make sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
This is the mapping between detail and Sub Minor Code. Refer entity for more detail
This is the mapping between the and Sub category
Sr. No. | Property Type Code* | Property Type* (In English) | Property Type* (In Local Language) |
---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Road Type Code* | Road Type* (In English) | Road Type* (In Local Language) |
---|
All content on this page by is licensed under a .
Sr. No. | Construction Type Code* | Construction Type (In English)* | Construction Type (In Local Language)* |
---|
All content on this page by is licensed under a .
The Property Sub Type represents 2nd level classification to the and provides the option to further classify the property type in sub types. For example property type ‘Built-up’ is further classified into Independent House, A Flat In Apartment and Half Constructed Half Open and considered differently on tax calculation procedure.
Sr. No. | Property Sub Type Code* | Property Sub Type* (In English) | Property Sub Type* (In Local Language) | Property Type Code* |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No | Usage Category Major Code* | Usage Category Major* (In English) | Usage Category Major* (In Local Language) |
---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
1
BUILTUP
Built-Up
निर्माण
2
VACANT
Vacant Land
खाली जमीन
1
Property Type Code
Alphanumeric
64
Yes
Unique Identifier for property type record
2
Property Type (In English)
Text
256
Yes
Nomenclature of “Property Type” in English
3
Property Type (In Local Language)
Text
256
Yes
Nomenclature of “Property Type” in local language e.g. Telugu, Hindi etc
1
Make sure that each and every point in this reference list has been taken care of
1 | RD1 | Less than 12 meters in width | 12 मीटर से कम चौड़ाई वाले मार्ग पर |
2 | RD2 | From 12 meters to 24 meters in width | 12 मीटर से 24 मीटर तक की चौड़ाई वाले मार्ग पर |
3 | RD3 | More than 24 meters in width | 24 मीटर से अधिक की चौड़ाई वाले मार्ग पर |
1 | PUCCA | Pakka Building With R.C.C. Roof or R.B. Roof | पक्का भवन, आर0सी0सी0छत या आर0बी0 छत सहित |
2 | SEMIPUCCA | Any Other Pakka Building | अन्य पक्का भवन |
3 | KUCCHA | Kuccha building that is all other building not covered in clauses (a) and (b) | कच्चा भवन अर्थात समस्त अन्य भवन जो (एक) और (दो) में अच्छादित नही है |
1 | SHAREDPROPERTY | Flat / Part of the building | फ्लैट / भवन का हिस्सा | BUILTUP |
2 | INDEPENDENTPROPERTY | Independent House / Whole Building | स्वतंत्र घर / पूरी इमारत | BUILTUP |
1 | RESIDENTIAL | Residential | आवासीय |
2 | NONRESIDENTIAL | Non-residential | गैर आवासीय |
3 | MIXED | Mixed | मिश्रित |
1 | Usage Category Major Code | Alphanumeric | 64 | Yes | This is a unique identifier being assigned to every major category. |
2 | Usage Category Major (In English) | Text | 256 | Yes | This is the description of the major category in the English Language. |
3 | Usage Category Major (In Local Language) | Text | 256 | Yes | This is the description of the major category in the Local Language e.g. Telugu, Hindi etc. |
1 | Property Sub Type Code | Alphanumeric | 64 | Yes | Unique Identifier for property sub type record |
2 | Property Sub Type (In English) | Text | 256 | Yes | Nomenclature of “Property Sub Type” in English |
3 | Property Sub Type (In Local Language) | Text | 256 | Yes | Nomenclature of “Property Sub Type” in local language e.g. Telugu, Hindi etc. |
4 | Property Type Code | Reference | 64 | Yes |
1 | Make sure that each and every point in this reference list has been taken care of |
1. | Make sure that each and every point in this reference list has been taken care of |
The Update Mobile Number feature in PT
Reminds ULB users about any invalid mobile numbers that exist in the owner records and enables them to update these.
Enables ULB users to update the mobile numbers as per requests from the property owner(s).
Enables property owner(s) to update the mobile number in their record to log in to the system.
If the mobile number is invalid it throws a warning in the property info screen whenever the user tries to pay the dues.
Mobile Number is invalid if it doesn't match the pattern defined in the MDMS config and if the number equals to the invalid number.
The Update number popup for employees requires a few documents to be uploaded. Citizens must provide the OTP received on the new number to update details.
Citizens must provide the OTP received on the new number to update details.
Update number component related files are present in the egov-ui-kit packages available in the link below.
Update API is used to update the property mobile number
property-services/property/_update
To update the number, just update the owner.mobileNumber
To update alternate number the API used is
property-services/property/_addAlternateNumber
Update owner.alternatemobilenumber
Click on the Edit Existing Number. A popup appears to update the number.
Enter the new number that needs to be added. Click on Send OTP.
UI makes an API call to user-otp/v1/_send
with type as login to send the otp if it is registered.
In case the OTP fails then type register in the same API to create a new user.
Once the OTP is entered, it verifies and validates the user in both cases (in case of register the citizen gets registered).
Once the OTP is validated, the Property Update call is triggered to update the number in the property object.
Note: Employee users have to upload supporting documents and the property update API call is triggered directly. Steps 3,4, and 5 are skipped.
PT Alternate Number feature enables owners to add an alternate number for the property.
We can add an alternate number while creating the property. The system also provides the option to add an alternate number after making a payment.
Alternate Number component details link
Steps To Add Alternate Number
Click on Add Alternate Number. A popup opens to add the alternate number.
The system sends an OTP to the registered number.
Once the user enters the OTP, the system validates it.
Enter the new number that needs to be added. Click on the Send OTP button.
UI makes an API call to user-otp/v1/_send
with type as login to send the OTP if it is registered.
If it fails then type register in the same API to create a new user.
Once the OTP is entered, it verifies and validates the user in both cases (in case of register the citizen gets registered).
Once the OTP is validated, the Property Update call is triggered to add the alternate number in the property object.
Usage Category Minor is nothing but a further classification of Usage Category Major, which can be explained as a broad diversification of the usage of your property.
This broad diversification is ideally used to classify the tax amount to which a property could be exempted from.
Below mentioned is the data table that is used for collecting data:
Please note that the data mentioned in the table is sample data, however, the state might further update this on the basis of their requirements.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Gather all the details available for the usage category minor type.
Start collecting the codes for the same, if not available abbreviate the description to create a relevant code.
Start filling the template with the codes and descriptions for details in the relevant columns.
After that start mapping them with the relevant Usage Category major codes.
Get the rates as well as amounts for the exemption if any.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
This is a further or third level sub-classification of the property usage types into sub minor category. Here the properties can be further classified such as commercial food joints etc.
Below mentioned is the data table from the template used to collect the data:
The data given in the table is sample data.
Download the data template attached to this page.
Get a good understanding of all the headers in the template sheet, their data type, size, and definitions by referring to the ‘Data Definition’ section of this document.
In case of any doubt, please reach out to the person who has shared this template with you to discuss and clear your doubts.
Identify all the sub minor categories used across the state.
After which identify the codes of all the sub minor categories, if not present abbreviate the description.
Get the details(description) of these codes.
Start filling the template with the codes and description in English and one native language would be helpful.
Get the exemption maximum amounts and their respective percentages.
Most importantly do get a mapping of these sub minor codes to their parent which is minor usage type.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed on the data that is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Not Applicable
Ownership Transfer Technical documentation
The mutation service provides a facility to change ownership of a property in relation to sales, inheritance of property. it helps by providing a workflow on config and allows the municipality to collect payment with ease on approval of the process. The mutation flows ad APIs exist within the property-services code base and makes use of all the mentioned external services and configured values, in addition to those the rest can be used to control mutation flow.
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
Prior knowledge of the demand-based systems.
Following services should be up and running:
user
MDMS
Persister
Location
Localization
Id-Gen
Billing-service
URL-shortener
Enables the user to create a mutation and transfer the ownership to the new owner.
Workflow config:
In Addition to property information and the extra owner information being added, some other information is required for workflow
The Creation Reason in the property should be sent as MUTATION for the request to be considered as a mutation request.
Along with the workflow name for mutation, a few extra details have to be provided in the additional details field of the property. Also either a new owner has to be added or an existing one has to be set to inactive for a valid mutation request.
The business workflow config follows the structure given for property workflow with respective name changes.
Workflow sample config for Mutation.
The property services will make a call to the mutation calculator at the required interval during the mutation flow.
The mutation service belongs to the property service itself and provides the same ease of access for the functionality.
Pick a property id that is already created in the system.
call the property/update API by changing the owner information or adding new owner information.
workflow information must be added mandatorily before submitting the request.
The calculation logic for mutation fee depends on the usage type of property (RESIDENTIAL, NON-RESIDENTIAL, etc ) and the current market value of the property.
If the current market value (CMV) of the property comes in between the minimum and maximum market value range of billing slab and the usage type of property match with the usage type for that billing slab then the mutation fees for that property is the amount mentioned in that particular billing slab.
Further, there are two calculation types which are FLAT and RATE which have to set by state/ULB for their billing slab for property mutation. If the calculation type is set as FLAT then mutation fee is the fixed amount mentioned in the billing slab which is used for the property.
If the calculation type is set as RATE the Mutation fee is X% of the current market value, where X is the percentage rate mentioned in the billing slab which is used for the property.
Other factors influencing calculation can be :
Ownership type
Property type
Locality
When the property is registered for mutation/transfer of ownership and all the document is submitted, then the mutation fees have to pay within a specified period of time of property mutation registration date. If a person fails to pay the amount of the fee before the deadline date, then some penalty charges have to pay. The penalty charge is Y% of the tax amount. The penalty percentage is set by the state/ULB. If a person pays the amount of the fees within the specified month of the property mutation registration date, then a certain amount is rebated from the tax amount. The rebate charge is Z% of the tax amount. The rebate percentage is set by state/ULB.
Note: For mutation fees calculation, document date value (means the date at which property is registered for mutation), market value of property, usage type value of the property is essential.
Please refer to the parent for external services: Property Services | Doc-Links
Service configuration details
One of the major applications of the eGov stack which helps municipalities and citizens to handle property tax payments and other related functions on the property such as assessments, mutation, and so on.
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
Prior knowledge of demand-based systems.
The following services should be up and running:
user
MDMS
Persister
Location
Localization
Id-Gen
Billing-service
URL-shortener
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 so as to calculate and pay tax on the property. The different services provided by the property services are
Property Registry
Assessment
Mutation
Bifurcation
Consolidation
Registry Explanation
The registry flow helps the citizen/Employee to create a property in the system with 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.
The same entry in the registry can be referred to by other modules for their business purposes(Water charges).
Persister File Config
The persister File config for property services can be found in the Config repo of eGov Git, which needs to be added in the persister service - property-services-registry.yml
Workflow-configs
Each flow in the property has a workflow associated with it, which can be controlled by the following configs. The Boolean field which can enable/disable Workflow - the same field controls the update and create the workflow
Workflow Config for property create if the source is from the WATER CONNECTION module
For the creation of property from the water and sewerage module, a different workflow config is used. For each use case, to identify which workflow to use can be identified from this mdms file.
Fields in the above MDMS file
Note: The above objects indicate that for each use case, only one object (use case) enabled the field must be set as true
one-stepSample 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
Property service can be integrated with any organization or system that wants to maintain a record of the property and collect taxes with ease.
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.
Customers can create a property using the /property/_create
Search the property using /property/_searchendpoint
/property/_update endpoint to update the property demand as per need.
Mutation can be carried out with the help of /property/_update itself, no extra API is needed.
Doc Links
API LIST
The update feature in property services provides a facility to update the owner’s primary mobile number (referred to as ‘mobile number’ hereafter). The already existing update API is used with some enhancements to implement this feature. Also, a facility has been provided to add an alternate mobile number for every owner of the property. This can be done using the newly created addAlternateNumber API. The alternate number can also be updated using this API.
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
Prior knowledge of the demand-based systems.
Following services should be up and running:
user MDMS
Persister
Location
Localization
Id-Gen
Billing-service
URL-shortener
Enables user to update property owner’s mobile number and to add/update the alternate mobile number.
All the property information (except the owner’s mobile number/ alternate number) should be the same as the information from the search result. The owner’s primary mobile number has to be necessarily different from the existing one.
The Creation Reason in the property should be sent as UPDATE for the request to be considered as an update request. Also, the property has to be in ACTIVE status. For adding/updating alternate numbers, modify the alternateMobileNumber field in the Property.
Sample request for updating primary mobile number or adding/updating alternate number.
Configs:
The update service belongs to the property service itself and provides the same ease of access for the functionality.
Pick a property id that is already created in the system.
call the property/update API by changing the owner’s mobile number.
Steps to Integration (updating alternate number):
Pick a property id that is already created in the system.
call the property/addAlternateNumber API by adding/changing the owner’s alternate number.
The assessment set of services inside the property module is used for assessing the value of a property in a given time frame and collect taxes for the same. Assessment is a snapshot of Property for a given transaction on that Property. These APIs provide functionalities to create/update/search the assessments. An assessment cannot exist without property.
Configs
Assessment shares most of the configs with Property as mentioned above, only exclusive properties are mentioned in this section.
Workflow Config
Sample businessService create API body for Assessment workflow:
Other system-level configs are the same as PT-Registry as mentioned above.
Notification Configs
Payment Notification
For adding localization for any status append ASMT_ prefix to the status and for adding a message for any status add ASMT_MSG_ before the status.
Assessment ****(Property Calculator) -
The calculator service Prepares and property tax and files the demand in the billing service for payment. It has the ‘estimate’ API to give the estimated property tax without persisting data and a calculated API to create demand for payments.
Assessment integration helps citizens to assess their property with ease and helps them verify their tax values by themselves which gives more control to the citizens and hep the municipality collect taxes with ease.
Easy to create and simple process of self-assessment to avoid the hassle.
Integrated payment for multiple years enables by digit platform.
Customer can create an assessment on a given property using the /assessment/_create
Search the assessment and its workflow status by using /assessment/_searchendpoint
/assessment/_update endpoint to update the assessment and its workflow states as per need.
API LIST
Property Type code referring to the
Sr. No | Usage Category Minor Code* | Usage Category Minor* (In English)* | Usage Category Minor* (In Local Language) | Exemption Rate (In %)* | Max Exemption Amount | Flat Exemption Amount | Usage Category Major Code* |
---|---|---|---|---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Usage Category Sub Minor Code* | Usage Category Minor Code* | Usage Category Sub Minor* (In English) | Usage Category Sub Minor* (In Local Language) | Exemption Rate(In %) | Max Exemption Amount | Flat Exemption Amount | Effective From Date |
---|---|---|---|---|---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Usage type | Minimum Market value | Maximum Market Value | Rate Percentage | Fixed amount | Calculation Type |
---|---|---|---|---|---|
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
MDMS CONFIG: https://github.com/egovernments/egov-mdms-data/tree/DEV/data/pb/PropertyTax - Connect to preview
name | value | description |
---|---|---|
MDMS Fields | Description |
---|---|
Title | Link |
---|---|
Title | Link |
---|---|
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Reference Docs: - For additional details please refer to the property document
All content on this page by is licensed under a .
For overview Please refer to the parent file -
MDMS CONFIG:To show a preview of this link, connect your Github account.GithubConnect
PERSISTER CONFIG: ``
The first property switches workflow on or off, while the second property provides a way to control which field change can trigger the workflow. A businessService needs to be created using the workflow API.
The calculator service
please refer to the property document
All content on this page by is licensed under a .
API
Action Id
Roles
1
property-services/property/_addAlternateNumber
870
CITIZEN
,PT_CEMP
2
property-services/property/_update
954
CITIZEN,PT_CEMP
3
user-otp/v1/_send
1531
CITIZEN
4
/property-services/property/_search
1897
CITIZEN
,PT_CEMP
1.
RESIDENTIAL
Residential
आवासीय
NA
0
0
RESIDENTIAL
2.
COMMERCIAL
Commercial
व्यावसायिक
NA
0
0
NONRESIDENTIAL
3.
INDUSTRIAL
Industrial
औद्योगिक
NA
0
0
NONRESIDENTIAL
1
Usage Category Minor Code
Alphanumeric
64
Yes
This is the unique identifier that is given to every category.
2
Usage Category Minor (In English)
Text
256
Yes
This is the description of the Minor category in English.
3
Usage Category Minor (In Local Language)
Text
256
Yes
This is the description of the Minor Category in the Local Language.
4
Exemption Rate (in % )
Decimal
(12,2)
No
This column defines the % to which the property could be exempted.
5
Max Exemption Amount
Decimal
(12,2)
No
This is the maximum amount which the property can be exempted from.
6
Flat Exemption Amount
Decimal
(12,2)
No
The amount that should be exempted for a particular category from the property tax.
7
Usage Category Major Code
Reference
256
Yes
This is the mapping between the minor’s and major’s of the usage category which can be found in Usage Category Major
1
Make sure that each and every point in this reference list has been taken care of.
1
RESIDENTIAL
RESIDENTIAL
Residential
निवास
2
100
200
01-04-2020
2
RETAIL
COMMERCIAL
Retail
खुदरा
3
300
200
01-04-2020
3
HOTELS
COMMERCIAL
Hotels
होटल
5.1
200
300
01-04-2020
1
Usage Category Sub Minor Code
Alphanumeric
64
Yes
This is the unique code given to every category
2
Usage Category Minor Code
Alphanumeric
64
Yes
This is the relationship between sub minor and minor usage categories.
3
Usage Category Sub Minor (In English)
Text
256
Yes
This is the description of the sub minor category in English
4
Usage Category Sub Minor (In Local Language)
Text
256
Yes
This is the description of the sub minor category in Local Language
5
Exemption Rate (in % )
Decimal
(5,2)
No
This column defines the % to which the property could be exempted
6
Max Exemption Amount
Decimal
(5,2)
No
This is the maximum amount which the property can be exempted from
7
Flat Exemption Amount
Decimal
(5,2)
No
This is the flat amount by which the property owner can be exempted
8
Effective From Date
Date
NA
Yes
This the date from which the exemption is applicable.
1
Make sure that each and every point in this reference list has been taken care of
name
value
description
is.mutation.workflow.enabled
true/false
enables/disbales the workflow
PT.MUTATION
workfow config name
Residential
0
X lacs
A% of CMV
INR G
FLAT
Non -Residential
0
X lacs
E% of CMV
INR Q
RATE
Residential
X+1 Lacs
Y Lacs
B% of CMV
INR H
FLAT
Non -Residential
X+1 Lacs
Y Lacs
B% of CMV
INR H
RATE
Residential
Y+1 Lacs
>Y+1Lacs
D% of CMV
INR L
FLAT
Non -Residential
Y+1 Lacs
>Y+1Lacs
C% of CMV
INR I
RATE
Title
Link
API contract for MT calculator
API list to create Mutation Slabs mutation/_create, _search, _update
API list for MT-Calculator mutation/_calculate
is.workflow.enabled
true/false
enable disbale workflow
PT.CREATE
the name should match the config name in the workflow businessservice JSON
PT.LEGACY
PT.UPDATE
businessService
Name of workflow config
initialAction
Indicate the start(initial) action of the particular workflow mention in businessService.
inWorkflowStatusAllowed
This field indicate whether the property with application status as “inWorkflow” can be use with water and sewerage connection creation. If this field is true then for that particular use case, the property with “inWorkflow” status can be use with water and sewerage connection creation and vice versa
enable
If this filed is set as true, then the other fields associate with the particular object is use for property creation.
name
value
egov.idgen.ack.format
PB-AC-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ACK]
egov.idgen.mutation.format
PB-MT-[CITY]-[SEQ_EG_PT_MUTATION]
egov.idgen.assm.format
PB-AS-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ASSM]
egov.idgen.ptid.format
PB-PT-[cy:yyyy-MM-dd]-[SEQ_EG_PT_PTID]
citizen.allowed.search.params
accountId,ids,propertyDetailids,mobileNumber,oldpropertyids
employee.allowed.search.params
accountId,ids,propertyDetailids,mobileNumber,oldpropertyids
USER Service
url-shortening
MDMS
Billing-service
Location
Workflow
Persister
****
Localization
Id-Gen service
/Property/_create
/Property/_update
/property/_search
name | value | description |
kafka update topic | update-property-registry |
|
name | value | description |
assessment id format | PB-AS-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ASSM] |
kafka create assessment topic | save-pt-assessment |
kafka update assesmsent topic | update-pt-assessment |
assessment.workflow.enabled | true/false | Workflow integration can be controlled by the following two properties |
assessment.workflow.trigger.param | usageCategory,occupancyType,occupancyDate |
Procedure to integrate elastic search for Fuzzy search with any of the eGov modules.
Creating the index as per the requirement
The elastic index has to be used for fuzzy search due to performance enhancement and when PII fields are involved which cannot be accessed in DB directly to apply fuzzy logic.
When PII data are involved those fields shouldn’t be returned by the elastic search but only can be used to apply the filter. To enable this that particular field should be indexed but not stored.
eg -
In the above example, when data is posted, all the fields will be stored, but the index will never return the excluded source fields when searched.
Querying an index
This is a simple request, there are additional parameters that can be used to enhance the fuzzy search.
Elastic Integration with code
Add the elasticsearch host from the eGov cluster.
Divide the search params between the ones that will be sent to elastic and others to DB (search to elastic should be made only if the fuzzy fields are present in search request)
The result of the elastic search should be only the required primary-Id of the entity(property-id, trade license-id, etc..)
Then the resulting ids should be used in the normal search as it is.
Please refer to the following commit for the integration
Application Properties
Properties need to add for integration
The indices need to be reindexed for the fuzzy search to work if changes are done in the index. particularly in the case of protected fields being indexed but not to be returned in the search.
Reindexing for PT: Refer here.
Step 1
Get the current mapping of the pt index using the _mapping API
Step 2
Add the following json mappings in the existing mappings (parallel to properties key):
Sample QA final mapping for reference is attached at the end.
Step 3
Recreate property-services-enriched with the new mapping.
Step 4
Update the indexer configuration, add the following 3 fields ownerNames
, doorNo
, street
in custom mapping as added below in sample configuration:
https://github.com/egovernments/configs/blob/qa/egov-indexer/property-services.yml
** If search has to be enabled only on names of only ACTIVE user, configure indexer jsonPath accordingly. Use $.owners[*][?(@.status=='ACTIVE')].name
instead in the config
Step 5
Restart indexer
Step 6
Trigger reindexing
Recreated property-services-enriched index with the new mapping
Created kafka connector
Hit the legacy index api
Once data is indexed in property-services-enriched, verify that all the data is indexed
After validating the data, drop the property-services index and use alias to point property-services
to property-services-enriched
Sample mappings from QA env:
Title | Link |
/assessment/_create |
/assessment/_update |
/assessment/_search |
Objective: Common PT is used as a plugin for other modules to search or create a lightweight property data on the go and tag it to the requesting module.
CommonPT module provides two ways to search for a property. Users can search for a property either by Property Id or by Door Number.
Search By Property ID
The search by Property ID requires certain parameters to filter out required properties.
City Name (Drop Down)
Owner Mobile Number (Input Field)
Property Id (Input Field)
Old Property Id (Input Field)
where City Name is mandatory and at least one more parameter like Mobile Number, Property Id or Old Property Id must be provided to find properties.
Search By Door Number
The search by Door Number form requires certain parameters to filter out required properties
City Name (Drop Down)
Locality (Drop Down)
Door Number (Input Field)
Consumer Name(Input Field)
Where City Name and Locality are mandatory at least one more parameter like Door Number or Consumer Name is required to find properties.
Once the user enters all required details, the form redirects the user to the list of all properties registered with the property id or as per the search parameters entered by the user
Clicking on the Select button redirects users to the OTP verification page. Users must enter the OTP sent on their mobile number to proceed further.
Users are redirected to the Property Details pages where the user can create new property using the existing property ID.
Clicking on Create New Property button, redirects users to create a new property page form. Users can enter the property details to be registered.
After filling in all details users can submit. The Acknowledgment page displays the application status as either Success or Failed along with the application number.
Common PT search and create feature is integrated with the TL (Trade License) module. The two flows of common PT allow users to:
Select the desired property using property search facility. The user can select the property from the search results.
Create a new lightweight property during the trade license application process. Once the acknowledgement page is displayed, the Proceed button is enabled to move forward with the flow.
Once the property is selected/created, property details is available on the next page Property Details.
Clicking on the View More Details button redirects users to the view property page that offers an overview detail of the attached property.
Common PT implementation code link:
Objective: The feature allows users to edit the application already created or update the property already registered to their mobile number. After verification, employees can send the application back to the citizen with remarks on required changes. The edit and update feature allows the users to make these changes. It also allows the user to update the details of the property details online as required.
If the property is marked as Send Back to Citizen, the application details page for employees displays the edit option at the bottom of the page.
If the property is marked as Verify → Forward → Approved, the Property Details page for the employees displays the Update option at the bottom of the page.
Clicking on the Update button allows users to edit or update property details. The Create Property flow is revisited. The only exception here is the values are pre-populated from the Property object received from Property Search API. On completing the flow the Update API is called and the property is updated successfully.
The main code contains the functions that transform the property object received in Search API. This includes primarily the Assessment flow units contextualized as per the Create flow since users have to revisit the Create flow with pre-populated details. The data values are updated accordingly. It also contains the routing details for the pages in the Create flow.
The Localization keys for Edit or Update Property are added to the ‘rainmaker-pt’ locale module. Changing, updating, or adding any new localization key is done in the same locale module.
Objective: Users can look for the list of the properties registered for their mobile number in My Properties tab.
The initial view for each property offers the Property Id, Owner Name, Address and status, along with the View Details button. Users can click on this button to look up more details about the registered property. In case the users do not find the property they are looking for, they can click on the Click here to Register New Property option to register the property.
Clicking on the View Details button displays the Property Information page containing the necessary information about the property.
The template for My properties and Property Information page is present inside pt/pages/citizen/MyProperties. The list of properties is retrieved by calling the search API /property-services/property/_search
.
This API is called using the React hook present inside the index of My Properties and Property information page. A single property is loaded, bypassing the unique Property Id in the search API.
If the search API result is successful, Assessment Search API is called to know the assessment status. Assessment Search API - /property-services/assessment/_search
.
If the assessment object returned fetches assessment array details then the fetch bill API is called to retrieve the payment details for the particular property.
Fetch bill API - /billing-service/bill/v2/_fetchbill
Following is the hook used for the property search API, assessment search and fetch bill.
No MDMS data is used here. All data is loaded from the Search API.
The localization keys for My Properties are added to the ‘rainmaker-pt’ locale module. Any changes, updates or addition of a new localization key are done in the same locale module.
Objective: Users can review the list of applications and their status registered under their mobile number in the My Applications tab.
Initially, only four applications are loaded on the screen. The user can click on the Load More option to view more applications. Each application displays the Application Number, Service Category, Property Id, Application Type and Status details along with the Track option. This enables the user to find more details about the application. If users are unable to find their property details on the system, a new application can be created using the link provided at the bottom of the page.
Once the user clicks on the Track button, the Application Details page is displayed with all the necessary information about the application.
Timeline component: The timeline component is available at the end of the application details. This provides the details on the current status and history of the application passing through various workflows and actions taken.
The template for My Application is present under pt/pages/citizen/PTMyApplications and the Application Details page is present inside pt/pages/citizen named as PTApplicationDetails. The list of applications is retrieved by calling the search API "/property-services/property/_search".
This API is called using the React hook present inside the index of PTMyapplication and PTApplicationDetails page. A single application is loaded bypassing the unique Property Id in the search API.
Following is the hook used for the property search API.
The two main util functions and their objectives are given below:
Create Util Function: While going through the Create flow, all the inputs provided by the user are stored in a different structure. Since the units are not separated in the flow but incorporated into distinct categories, the storing structure is different from the request body of Create API. This function transforms the flow of stored data into the requested body format.
No MDMS data is used here - all the data is loaded from the Search API.
For My Applications, the localization keys are added to the ‘rainmaker-pt’ locale module same as in My Properties and Create Property. Any changes, updates or addition of any new localization key is done in the same locale module.
Objective: To provide user facilities to add a new property, view the property details and the application currently on their number. The feature allows users to update the property or edit the application.
Users can add new property using the Create Property button. The workflow captures user inputs through multiple questions and information gathering screens. At the end of the flow, a check page is displayed that enables the user to cross verify the information entered. The application is created on clicking the submit button.
Property tax registration information screen is displayed after login. This helps the user identify the required documents to complete the new registration for the property.
The users are prompted to enter the details about the property first. The flow chart below illustrates the property details flow.
The user is next asked to provide the assessment details. This flow captures information related to each floor and the basement.
Instead of capturing unit data in separate pages the system captures data in one page only. Users can add multiple units by clicking on the Add One More Unit button. The respective unit page loads for each floor and users can add the corresponding units as required.
After entering property details, the user is prompted to provide the address of the property. The flow is straightforward, without any conditional routing.
Users can pinpoint the location in the Geo-location map, according to which pin code and city, as well as locality, is auto-populated.
Finally, the user is prompted to enter the property owner details. Ownership can be institutional - either Government or Private. Ownership can also be Single or Multiple owners. The system prompts the user to fill in the details accordingly.
In the case of Institutional, the following data is asked in the first screen. The subsequent screen does not change.
In the case of single or multiple owners the following screen is displayed. The rest of the flow remains the same.
The check page allows users to cross-verify the information furnished across the flows. Users can click on the change button available adjacent to the relevant data to make any change or update the input data. The user is redirected to the relevant page for updates. The subsequent flows are repeated till the user submits the application.
The Create API is called for registration of property. Following is the snippet of the Create API used: 1create: "/property-services/property/_create"
If the API response is successful, then the acknowledgement screen is displayed, else the failed acknowledgement screen is displayed.
All the screens have been developed using the new-UI structure followed previously in the FSM and PGR module.
The link for the Create Property main index is given below. This provides a better understanding of the starting point of the flow:
PT (Property Tax) Module has been segregated into a specified structure. All the screens configuration is available inside the PageComponent Folder. The configuration for routing the pages are mentioned in the config folder common for both citizens and employees. The snippet for the folder structure and routing configuration is given below.
The high-level configuration for controlling the whole flow for citizens and employees is available in the Pages folder. Citizen flows include Create, Edit, My Properties, My Application and Search Property. The search property flow carries the index (the main starting point of the whole flow).
The Utils folder basically contains all the methods used across the PT module. In case there is a common method that needs to be added, it can be imported into other files.
For creating an application the Create API from Property Tax is called using the React hooks. This hook is declared under hooks or elements of PT as PTService.
Data across some of the pages are imported from MDMS throughout the flows. The table below lists the pages using MDMS data. In these pages the .js files are found under page components.
Data React hooks are used to call MDMS and these are shared across the module. The code snippet below contains the call used for MDMS.
Localization keys are added to the ‘rainmaker-pt’ locale module. In future, if any new labels are implemented in the Property Tax (Citizen) they should also be pushed to the locale DB under rainmaker-pt locale module. Below is an example of few locale labels.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
to access the Edit/Update property main index.
Update Util function: this function does the exact opposite of the Create util function (refer to ). The property object received from the Property Search API is converted to the Create Flow relevant structure to pre-populate the values for user convenience. The application is updated on completing the flow. The link for the same .
MDMS data used here is the same as the Create flow since the flow structure used for edit/update property is the same as the create property flow. Please refer to the .
All content on this page by is licensed under a .
for the My Properties and Property Details common Index.
All content on this page by is licensed under a
details for My Applications and Application Details common Index.
to fetch the code.
Click here to find detailed information about this function.
All content on this page by is licensed under a
After completing the flow users can download the acknowledgement details of the property created in pdf format. Click the config for the PDF generation.
PageComponent | MDMS Detail | Module Detail Name | Master Detail Name |
---|
Link | Description |
---|
All content on this page by is licensed under a .
API
ACTION ID
ROLES
/property-services/property/_search
/billing-service/bill/v2/_fetchbill
1862
/property-services/property/_create
/egov-mdms-service/v1/_search
954
/localization/messages/v1/_search
1531
API | Roles | Action Id |
/access/v1/actions/mdms/_get | CITIZEN | 870 |
/egov-mdms-service/v1/_search | CITIZEN | 954 |
/localization/messages/v1/_search | CITIZEN | 1531 |
/property-services/property/_create | CITIZEN | 1895 |
/property-services/property/_search | CITIZEN | 1897 |
/property-services/property/_update | CITIZEN | 1896 |
/property-services/assessment/_search | CITIZEN |
|
/billing-service/bill/v2/_fetchbill | CITIZEN |
|
Url | Roles | Action Id |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Url | Roles | Action Id |
|
|
|
|
|
|
|
|
|
|
|
|
PropertyTax | List of documents required for each category |
|
|
PropertyUsageType | Four category imported - (Commercial, industrial, institutional & others) |
|
|
PropertyType | three major categories - (Independent, Flat & Part of the building & Vacant) |
|
|
SubUsageType | List of sub-usage category according to the property usage selected before |
|
|
SubUsageTypeOfRentedArea | List of sub-usage category according to the property usage category selected before, same as sub-usage type |
|
|
PTSelectAddress | List of Cities (Amritsar, Jalandhar and Nawanshahr) and List of localities according to the city selected |
|
|
OwnershipDetails | Four categories imported - (Institutional - private, Institutional - Government, Single Owner and multiple Owner) |
|
|
SpecialOwnerCategory | List of special category imported eg Freedomfighter, handicap etc |
|
|
PTGeolocation | Default value for location i.e Pratap Nagar Latitude and longitude |
|
|
RentalDetails | Rentaldetails information regarding tax percentage is taken from MDMS |
|
|
API | Action Id | Roles |
/access/v1/actions/mdms/_get | 870 | CITIZEN |
/egov-mdms-service/v1/_search | 954 | CITIZEN |
/localization/messages/v1/_search | 1531 | CITIZEN |
/property-services/property/_create | 1895 | CITIZEN |
/property-services/property/_search | 1897 | CITIZEN |
/property-services/property/_update | 1896 | CITIZEN |
/property-services/assessment/_search | CITIZEN |
/billing-service/bill/v2/_fetchbill | CITIZEN |
Property applications |
Registered properties |
Application details |
Property information |
Edit or update property details |
Make payment or search property details |
Objective: Provide users with the payment details for properties registered to the given mobile number and facilitating payments.
Users can view the list of payments for properties registered to their mobile number in My Payments tab. The initial view displays the Amount Paid, Property Id, Owner Name, Receipt Date and Receipt Number, and the Download Receipt options. Clicking on the Download Receipt button offers a payment receipt details.
Clicking on the Download Receipt button downloads the payment receipt.
My Payments common index file link: https://github.com/egovernments/DIGIT-Dev/blob/develop/frontend/micro-ui/web/micro-ui-internals/packages/modules/pt/src/pages/citizen/MyPayments/index.js
Static screen file link: https://github.com/egovernments/DIGIT-Dev/blob/develop/frontend/micro-ui/web/micro-ui-internals/packages/modules/pt/src/pages/citizen/MyPayments/PTPayments.js
The property search API is called in order to get all the properties linked to the mobile number -https://qa.digit.org/property-services/property/_search?_=1646986118830
Next the payments search API is called to retrieve the payments for each property -
API Hooks used to call APIs are in the index file of My Payments
No MDMS data is used here. All data is loaded from the Search API.
For My Payments the Localization keys are added to the ‘rainmaker-pt’ locale module. Any changes, updates or addition of new localization keys is done in the same locale module.
Bill details and payer details
Objective: The Search and Pay feature enables the user to search the property (with or without login) and pay any pending dues. It provides the user with the option to load all the bills linked to the registered mobile number and pay the bill.
Users can search for Property with or without login. Property can be searched either using Property Id or using property details.
Once the user provides certain parameters it calls the search property API and displays the search results accordingly.
Clicking on the View Details button redirects the user to the bill details page. The users can pay the dues from this page.
Users can view the break-up of the total amount due and select full or partial payment as required. They can enter the amount to be paid in case the partial payment option is selected.
Clicking on the Proceed To Pay button redirects the users to the Payer’s Details page.
For Logged In Users, the below information is captured.
I am making the payment as the owner/ consumer of the service.
I am making the payment on the behalf of the owner/ consumer of the service.
In case of option (i) is selected, the owner’s detail is linked with the receipt.
In case option (ii) is selected, the user’s profile detail is linked with the receipt.
For without login users, the below information is captured.
I am making the payment as the owner/ consumer of the service.
I am making the payment on the behalf of the owner/ consumer of the service.
In case of option (i) is selected, the owner’s detail is linked with the receipt.
In case option (ii) is selected, the user is asked to enter the Name and Mobile No. and the same is linked with the receipt.
Based on the selected option the user is redirected to the total amount page. The flow is same as DIGIT Payments from this screen.
The payer information for the payments API is added based on the mentioned criteria.
Objective: The Quick Pay feature allows a citizen to quickly view or pay all his pending bills for Property Tax (or any other supported business Service) by clicking links directly from the Digit-UI home screen.
Clicking on the Property Tax link in the Quick Pay section, a user is redirected to the My Bills screen. Else, the user has to log in using his mobile number and the OTP is sent to the number. The user is then redirected to the My Bills screen.
On the My Bills screen, the user finds his pending property tax bills (displayed as cards) for registered properties. The user can click on the View Details button of the corresponding card to check the detailed bill summary which takes him to the bill details page. There is also a link for the case when the user is unable to find the property tax bills.
The Bill Details screen shows a list of various categories of applicable taxes. After checking the user can select to pay either the full amount or the custom amount, which cannot be less than ₹100 and not more than the total tax. These restrictions, however, are customizable as per ULB requirement and can be changed in the MDMS.
Clicking on the Proceed To Pay button redirects the user to the Pay screen. The user is asked to select the payment gateway using the radio buttons. On clicking pay, the user is redirected to the bank payment gateway.
After making a successful payment through the bank gateway, the user is redirected to the response screen which shows the details of the payment and other bill details.
In case the payment fails for any reason the response screen shows the message, that the payment transaction has failed.
Use Case: when user wants to pay for property registered to a different mobile number
My Bills page only displays the properties with pending taxes linked to the mobile number used to log in. To search and pay for any other property, users can click on the link below the My Bills screen that redirects the user to the search screen.
On the Search screen, the user can search a property by mobile number, a unique property ID, or an existing property ID. The search parameters redirects the user to the search results screen. Here users can see all the properties with the matching criteria, whether or not they have pending taxes.
Clicking on the View Details buttons redirects the user to the bill details screen.
My Bills Screen
Click here to fetch the My Bills screen starting file
An MDMS call is made to this page to fetch details based on the defined restrictions such as partial payment is allowed or not, advance payment allowed or not, minimum payable amount etc. for the particular business service which is supplied into URL.
The MDMS criteria used here for fetching MDMS details are:
The pending bills are fetched for the citizen for the specific business service using the custom hook, that fetches bills linked to the logged-in mobile number.
The bill is rendered using a keynoteConfig file which can be located here.
On this page, for each business service, there is a configuration stored to define what part of the bill is to be displayed.
The configuration returns an object of structure.
Here my-bill key has config for the my-bills screen. This configuration decides what details to show on the card for each service from the bill object returned by the fetchBill API.
It is an array of objects, where each object puts the bill detail on the My-Bills bill card.
Each object contains 4 properties ie keyValue, keyPath, fallback, noteStyle
. The keynote config is added into the Digit component Registry as getBillDetailsConfigWithBusinessService
The implementation of the config can be found here.
Bill Details Screen
The bill details screen can be found here.
It checks for various payment restrictions that are fetched from the MDMS on above mentioned My Bills description. The tax heads that are to be displayed in the summary are also fetched from the same MDMS.
The structure for payment rule response from the MDMS are -
partPaymentAllowed
key when true allows payment less than bill details to be paid otherwise the user can pay only the bill Amount.
minAmountPayable
is the minimum bill amount a user can pay.
isAdvanceAllowed
if the true user can enter the amount more than the specified.
The link for the MDMS can be found here.
Payment Screen
The payment screen fetches the payment gateways from an MDMS call.
The code can be found here.
Response Screen
The response page code can be found here.
Search Screen
The search screen is a part of PT module and its code can be found here.
Search Result Screen
The Search Result screen code can be referred to here.
The keynote config is responsible for adding the new bill UI for adding a new bill for a business service.
The whole function is exposed within the component Registry as getBillDetailsConfigWithBusinessService
and can be redefined from here.
Objective: To provide employees with the functionality to search Applications (whether Active or in workflow) based on
Application No.
Property ID
Owner’s Mobile No.
Application Type
Application Status
Create Between Dates
Users can view the application details page by clicking on the application number. The details page allows the employees to initiate and perform different workflow actions.
The below hook is used to call the Property Search API and load the search result:
1const { isLoading, isSuccess, isError, error, data: {Properties: searchReult, Count: count} = {} } = Digit.Hooks.pt.usePropertySearch( 2 { tenantId, 3 filters: payload 4 }, 5 config, 6 );
Objective: To provide the employees involved in PT workflow, the functionalities to create a property Application in create workflow.
A counter employee can use create an application form, to register a citizen’s property.
The file for create Application form for PT can be found in:-
for creating an application employee enters all the details of the form manually, and Documents are uploaded based on the MDMS configuration found in the file:
MDMS Data
The MDMS data for documents is similar to that found in :
**with the noted addition of formDataPath, formArrayAttrPath
, in filterCondition
and dropdownFilter
.
formDataPath
path is the form path in form of an array of keys that requires to be followed to a new UI form to check the entered value. similar to jsonPath
and parentJsonpath
in old UI, While the formArrayAttrPath
replaces the arrayAttribute
.
The use of the MDMS data within the component can be found in :
After adding all the valid documents and form values in the form, the user is allowed to submit the form
which calls the property create API:1property-services/property/_create
Acknowledgement Screen
If the Property creation is successful. then the employee is directed to this screen that shows Acknowledgement Id and the option to download a hardcopy of the acknowledgement containing property details.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
File link for the code for payer details: https://github.com/egovernments/DIGIT-Dev/tree/develop/frontend/micro-ui/web/micro-ui-internals/packages/modules/common/src/payments/citizen/payers-details - Connect to preview
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Search application file link:
Hook file path:
All content on this page by is licensed under a .
Url
Roles
Action Id
egov-workflow-v2/egov-wf/process/_search
PTCEMP,FI,APPROVER,DV
1730
/property-services/property/_search
PTCEMP,FI,APPROVER,DV
1897
/egov-workflow-v2/egov-wf/businessservice/_search
PTCEMP,FI,APPROVER,DV
1743
/filestore/v1/files/url
PTCEMP,FI,APPROVER,DV
1528
/egov-mdms-service/v1/_search?
PTCEMP,FI,APPROVER,DV
API
Action id
Roles
/access/v1/actions/mdms/_get
870
CITIZEN
/egov-mdms-service/v1/_search
954
CITIZEN
/localization/messages/v1/_search
1531
CITIZEN
/billing-service/bill/v2/_fetchbill
1862
CITIZEN
,
/pg-service/transaction/v1/_create
1571
CITIZEN
/collection-services/payments/_search
1864
CITIZEN
/pg-service/transaction/v1/_update
1572
CITIZEN
collection-services/payments/PT/_search
2029
PTCEMP,
CITIZEN
API
Action id
Roles
/access/v1/actions/mdms/_get
870
CITIZEN
/egov-mdms-service/v1/_search
954
CITIZEN
/localization/messages/v1/_search
1531
CITIZEN
/billing-service/bill/v2/_fetchbill
1862
CITIZEN,
/pg-service/transaction/v1/_create
1571
CITIZEN
/collection-services/payments/_search
1864
CITIZEN
/pg-service/transaction/v1/_update
1572
CITIZEN
collection-services/payments/PT/_search
2029
PTCEMP, CITIZEN
Url | Role | Action Id |
|
|
|
|
|
|
Url | ROLE | Action ID |
|
|
|
Objective: To provide employees with the ability to Edit property Details (except Owner Details).
The Edit form can be used to update the details of an approved property, or whenever an application is in a workflow state that allows/require employees to make changes.
All the updatable Input fields are enabled, and all the fields related to owner details are disabled.
After editing and clicking submit when the user is successful the user is redirected to a success screen similar to that in Employee Create.
The implementation details are similar to the create application and uses the same MDMS configurations.
APIs called:1property-services/property/_update
The Update API is supplied with updated property values from the form. All units that are added at the time of creation are set to active
: false
. The new units are set to active
: true.
This applies even when no changes are made to the units.
Acknowledgement Screen
If the Property Update is successful. then the employee is directed to the Acknowledgement screen. The screen displays the Acknowledgement Id and the option to download a pdf copy of the acknowledgement containing property details.
Objective: To provide employees with the functionality to search properties (either in active or in workflow status) based on locality, owner mobile, or unique Property Id.
The employee also can see the dues for property within the search results and can choose to pay the dues if any, by clicking on collect tax.
Users can also view the current property Details page, to view Property Details, where employees can perform actions like assessment, Updation and Mutation, on an approved active Property.
APIs
The 1st API is used to fetch all the localities, based on the logged in tenant.
The 2nd API is used to fetch the search results of the table data.
The 3rd API is used to fetch the bills showing the taxes due details in search results.
Property Details Page
This page is visible to the employee when they click on the property ID of the property in search.
Here employees can see the latest approved property details. The employee also has the option to start property assessment, transfer ownership, and edit property details.
The employee also has the option to view history - this enables the users to view the owner details within the history of the property.
Payment History
Users can access the payment history of a specific property as well as download the receipt for the same.
APIs
Same as in the case of application details. The latest approved data is shown and any data which is not in the workflow is filtered out.
Assessment Popup
The popup is displayed when an employee chooses to assess property from the property details page of active property.
The popup displays the list of financial years to select from:-
A financial year is selected for the assessment of the property.
Technical Details
Assessment Screen
Clicking on the Assess Property button displays the Property Assessment screen.
This screen gives the assessment details of the selected financial year from the popup. It also provides an overview of the property as well as the total calculation details. This value is fetched from the MDMS.
After clicking on Assess Property, the button changes to Proceed To Pay that redirects the employee to the common pay screen.
Technical Details
The following hook is used to retrieve the charge slabs from the MDMS call
API Used
The 1st API is provided with the financial year and property Id as parameters to get the payment estimations for the property.
The 2nd API is used to fetch property details.
The 3rd API is used to create an assessment of the property - this provides the estimated tax value for the property.
Objective: Provide employees with the options to view the assigned, escalated applications and the applications that are pending for action.
Route - mSeva
Inbox screen can be divided into 4 sub components as listed below:
Sidebar
Quick action button
Service List
Inbox worklist
Action Menu is the component that shows the menu items in the sidebar based on the response from the access/v1/actions/mdms/_get
API .
Quick Action button which shows the menu based on the response from the access/v1/actions/mdms/_get
API.
Service List is the component that shows the menu based on the response from the access/v1/actions/mdms/_get
API.
Inbox worklist is the component that shows the records based on the response from the /egov-workflow-v2/egov-wf/process/_search
API.
Inbox worklist contains options to filter and search the records based on the options.
Fetching all the records from the process instance is not made in a single call since we might fetch a lot of records. So we make a call to get the total count from egov-workflow-v2/egov-wf/process/_count
API. After that, we load the initial records for all business services.
Once all the records are fetched the system loads the locality of the records based on the locality search provided by the service (BUSINESS SERVICE).
The Assigned To Me Tab displays all assigned applications for the logged-in user.
All records are fetched from the process instance response that filters the records based on the following condition:
1get(item, 'assignes[0].uuid')=== uuid;
Here, the UUID is the logged-in Employees User id and the item is the total records.
SLA of the Application is based on the businesssServiceSla
and it is converted using the following conversion:
item.businesssServiceSla / (1000 * 60 * 60 * 24)
Nearing Escalation and Escalated is identified based on the businesssServiceSla
present in that record and the configured MDMS data wfSlaConfig
It contains the slot colour and percentage.
Pagination is configured in the MDMS to hold default records and default options to show rows per page.
Table and Table pagination can be accessed from this file link below.
In every row, there is an option to view or perform an action on the record and this redirects users to the relevant module.
Refer to the Config below.
Redirection for every module should be configured in redirectConfig
and similarly for any other config like active, locality, and locality modules.
Here in Escalated tab, it makes an escalation search, using egov-workflow-v2/egov-wf/escalate/_search.
The object structure is similar to the process search.
On View History - It shows which state has it got escalated using flag. isEscalatedApplication
based on it it shows a red mark for the corresponding state.
Here all the filter options are derived from the records that we receive through the process instances. It is not from any MDMS data.
Objective: To provide citizens with the functionality to apply for Ownership Transfer for an active property.
The Transfer of Ownership Option is provided to citizens on the home screen in the citizen App, under property Tax card.
Upon clicking on “Transfer Property Ownership/Mutation” link, users are taken to property search page just like in case of “search & Pay” option, where he can search for the property he wants to search the property for.
After searching the property the user is shown the property details for the properties based on the search criteria. With Total Dues on top of the card.
If there are dues owed on the property (unpaid taxes), then users are shown a popup stating that the citizen has to clear his dues first. with a proceed to pay button that takes citizens to the common pay page, just like in the case of Search & Pay.
In case of dues cleared the citizen is taken to the Docs required Page, just like in the case of Employee Mutation, where he is shown the list of docs he is supposed to have in order to be able to transfer the property.
on this page after clicking on Transfer of Ownership, the citizen is made to go through the Ownership Transfer flow where he fills in the Ownership details and Mutation Details. After completing the flow citizen is shown with the success screen with his application number and the option to download his acknowledgement as a pdf.
MDMS data
The MDMS data is the same as in the case of employee Mutation Screen.
API used
The citizen mutation calls the property-services/property/_update
API to update the property status after that the application is gone through the Employee workflow to complete the transfer.
When Update API is called the documents are updated for the property according to the following snippet:-
Here originalProperty
is the property data before mutation, and mutationDocs
is the MDMS response for Mutation Docs.
Objective: To provide employees with the functionality to search for created applications.
The employee inbox screen shows all created applications in workflow and requires action from the logged-in employee.
The employee has the ability to search for specific applications based on application number, property ID, or mobile number. Filters can be applied based on the business service (create, edit, or update), application status, locality, and assigned applications.
Clicking on the application number hyperlink in the inbox redirects the user to the application details page. The user can take the required action on the application to push it forward or backwards in the workflow.
API Used
Below is the API used for searching the inbox:
The above API is used to fetch the Inbox results based on the selected filters and search criteria.
The inbox screen offers customization for the fields in the inbox table. The fields inside the inbox table are exposed in the component registry service as in the file:
It is exposed as PTInboxTableConfig
key in component registry service, and can be redefined to reset the columns. The function returns an object of the following structure:-
inboxCloumns
and searchColumns
functions return an array of objects where each object represents a column.
The inboxCloumns
is used for setting columns in the Inbox, while searchColumns
is used for setting columns.
Every column has the following properties:-
Header
is the heading that is used in the head
of the column (basically name of the column).
accessor
is .
separated string value that specifies the path within each row to be followed in order to display the value of the column. The structure of the row object is similar to row.original
explained below.
Cell
is a function returning a valid JSX. In case some complex component requires to be rendered, the function is supplied an object with row
property. Each row contains property details, with row.original
being the actual data for the property row. The searchData
contains search-related results associated with the property, while workflowData
contains workflow related data associated with property.
This page is where the employee is redirected after clicking on the application number in the inbox. The user finds the Take Action button at the bottom of the screen and performs actions based on the employee's role and the state of the application in the workflow. Users can also view the timeline where they can see the updates by other employees and the actions taken on the application so far.
The employee views details like owner details, address along with the documents attached at the time of creation. In the case of mutation applications, the employee can see transferer and transferee details.
While performing the action users can upload docs, add comments for the next employee in workflow, or they can assign them to a specific employees in the action resultant workflow.
If a particular workflow is completed then, the application is said to be completed and the status of property changes to ACTIVE
.
APIs Called
The application details page calls the following APIs.
the 1st API is called to fetch the timeline processed through the process instance.
The 2nd API is called to fetch address, owner-details, and document fileStoreId
for all the documents associated with the property.
The 3rd API is called to get current performable actions based on the existing process instance. This is then filtered through as per the actions performable by the employee’s role.
The 4th API is called to fetch all the documents for the file store ids.
Objective: To Provide employees with functionality to transfer Ownership of an active property.
When a property is in active status and has no dues to pay, the employee has the option to mutate a property on the Property Details page.
The doc required page is shown if the property is paid for otherwise the user is redirected to the payment details page. It shows the employee the list of documents required in order to proceed with the form.
Clicking on the Transfer of Ownership button on the required page redirects the employee to the Transfer of Ownership or Mutation form. Here the Transferor details are displayed and the employee can fill out the transferee details form.
MDMS Data Used
APIs Called: 1property-services/property/_update
When update API is called the documents are updated in accordance to the snippet below:-
Here data.originalData
is the property before the update. The data.documents
is the documents that were uploaded in the form, and mutationDocs
is the MDMS response for Mutation Docs.
Acknowledgement Screen
If the Property Mutation is successful. then the employee is directed to the acknowledgement screen. The screen displays the Acknowledgement Id and the option to download a pdf copy of the acknowledgement containing property details.
Migrating legacy data
This section covers the principles eGov will be following for migrating legacy property registry along with demand and collection balances to the DIGIT system (currently in Uttarakhand but can be used for other clients in future). eGov has been successful in implementing property tax applications in states of Andhra Pradesh, Punjab and various other Municipal Corporations like Greater Chennai, Nagpur and so on using best practices defined here.
The state team is supposed to take care of the below activities before property data is shared to eGov for data migration:
State team to share all master data and its localization that are part of the property tax. For example masters like - city, boundary, usage type, property type and so on
State team to do the data gathering and prepare the property tax data in the predefined template shared by eGov
Data prepared needs to be scrutinised by the data owner from the State’s team. Following data validations to be considered in particular:
Validate if all sheets have accurate records (owner details, property details and DCB details, Floor details) in terms of what is expected
DCB details can be more than the number of records in the property sheet
There can be multiple owners for a single property. But there needs to be an owner and DCB for each of the properties
Have a check on all mandatory data present
All sheets to be aligned with the unique id field
The state has to share the complete set of property data for a city in a single go. They can also give one set for residential properties and another for commercial properties, but cannot give multiple sets for the same.
Data owner to give a sign off on data before handing over to eGov team
State team to be aware of assumptions and default values that will be applied as part of the data migration process. This will be shared by the eGov team
UAT and production environment where the data is to be loaded to be provisioned and set up
Data received from the State team will be cleansed by eGov with default values
Mandatory fields that have no financial impact on citizens can be filled with default values in the absence of values specified by the State team. Few examples are listed below -
Covered areas can be updated as 0
Road type as 12 meters
The number of floors can be updated as 1
Certain fields that have a financial impact can also have default values like tax amount in the absence of values specified by the State team. (It can be updated as Rs.1)
If the mobile number is blank, a dummy mobile number will be updated. Care will be taken to ensure that this is not an actual mobile number and this number will be removed from notifications. Dummy numbers can be something like 99999xxxxx where the first few dummy numbers in a state will be 9999900001, 9999900002, 9999900003 so on.
Follow the below assumptions to do data cleaning
If the mobile number and user name combinations are duplicating we will consider these properties belong to the same owner. This means one user will be created in the system which will have a link to two properties.
Have a marker if any assumptions and default values are applied on a record
Certain data are currently not assumed or defaulted. Below listed are a few cases -
Owner details completely not available for a property - If complete owner details are missing, these records to be kept in the not to be migrated list.
If DCB is not there or given for a range of years - since there are a lot of use cases here, we can keep this record in the not to be migrated list
Duplicate old property id - leave the data as it is and then edit it later using the data entry screen
If boundary data is not present or data not aligned with the master data shared - update to a default mohalla which the state agrees to
Door number is not present - update the value as “door number”
Owner Name blank in the owner details sheet - update the value as “owner”.
Load the records using property migration kit to UAT server
Prepare a list of all passed and failed property records and share them back with the State team. Passed records along with values defaulted will be shared.
If the State team wants eGov to retry all failed records they are expected to come back with the revised data within one week.
Repeat Step 1 for revised records received from the State team.
The final status of the data load will be shared with the State team.
State team to verify data loaded on UAT server and provide a sign off for each of the ULBs within 1 week
On getting sign-off of UAT data, eGov will load that data to production using the migration kit used for loading to UAT instances. This can be done only if the production infrastructure is ready.
Get sign off on the production data before the application can be made live.
Communication for data migration exercise can be split into the following stages:
There will be a SPOC from the State team who is the data owner who will share data with the eGov team. Excel sheet data will be put on google drive and shared with the project manager from eGov. Similarly, all communications from the eGov side to State will be routed through the project manager.
Pre-migration
A demo of how PT module works - State + ULBs
Product fitment discussion, configurable data finalization and sign off - State
An overview of how data migration works - State + ULBs
Sharing the template (along with checklists and FAQs) in which we will collect data and type of data required against each field along with training - State + ULBs
Sharing assumptions which will be followed while migrating data - State + ULBs
During migration
Data inconsistencies observed in Data cleaning stage - State
Gaps needed to complete data migration (like mohalla mapping) - State
List of records which will be migrated as-is and the ones which will be migrated with assumptions - State
Post-migration
List of properties migrated without error - State
List of properties migrated with error for ULBs manual entry - State
UAT Sign-off document - State + ULB
Final confirmation post migration on Production - State + ULB
All failed records from the second pass will be manually entered into the system using data entry screens
The state has to make a mandate to collect property tax only using DIGIT.
All records with assumption markers or incorrect data can be updated by counter employees when citizens come for payment. Maybe this option can be given to the citizen when coming for online payment.
When a citizen is coming for making his payment, the counter operator can check if their property exists in the system using propertyid or mobile number. If it is found to be missing, it can be captured afresh in the system using the data entry option. All required information can be obtained from the citizen, either from previous year receipts that they carry or directly asking them.
With this approach, a ULB can go live with 90% of property data within a short time.
Data Migration Checklist
Data provided in the standard template attached only will be accepted for further analysis and process.
Data provided into the template is loaded into staging tables and then validation and data clean-up is done.
Properties with current Tax 0. (2020-21)
Properties with advance collection
Properties with current tax partially payment
Properties with Mohalla not configured in master
Masters mapping with the configured masters data in the system.
All the findings of data are reported to the onsite team and sought clarification.
Once all the queries/ findings are cleared/addressed data is moved into UAT.
Data is verified into UAT with sampling by the state team. Go ahead.
Preparing some basic checkpoints before moving into production.
Move the data into production and verify the checkpoints.
Edit Form implementation file link: digit-ui-internals/index.js at main · egovernments/digit-ui-internals
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
The file for search can be found in: digit-ui-internals/Inbox.js at main · egovernments/digit-ui-internals
The code details can be found in:digit-ui-internals/PropertyDetails.js at main · egovernments/digit-ui-internals
The financial year list is fetched from the MDMS:egov-mdms-data/FinancialYear.json at DEV · egovernments/egov-mdms-data
It also provides the counter employee with a chance to add penalty or rebate in the current bill and accordingly the total value is calculated. The counter employee needs to click on the Add Rebate/Penalty button that opens a popup containing the penalty and rebate details.
The file for the assessment Details page can be found here: digit-ui-internals/AssessmentDetails.js at main · egovernments/digit-ui-internals
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Inbox screen is loaded based on the file frontend/index.js at master · egovernments/frontend
Action Menu component file is present infrontend/index.js at master · egovernments/frontend. Based on the response the actions gets filtered based on the condition in navigationURL
The quick Action button is present in frontend/index.js at master · egovernments/frontend. Based on the response the actions get filtered based on the condition item.url === "quickAction"
frontend/index.js at master · egovernments/frontend based on the response the actions get filtered based on the condition item.url === "card"
These details are configured in CommonInboxConfig
MDMS egov-mdms-data/CommonInboxConfig.json at e8b7bad5ad7c4e17816dedb673b2f4085c92c8a6 · egovernments/egov-mdms-data
Functionality file path: frontend/index.js at master · egovernments/frontend
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Code link for citizen mutation: digit-ui-internals/index.js at main · egovernments/digit-ui-internals
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
File path for inbox: digit-ui-internals/Inbox.js at main · egovernments/digit-ui-internals
The object.PT
contains 2 keys- inboxColumns
and searchColumns.
These are functions that contain props
as an argument. These props are supplied to the component called DesktopInbox
as seen in the following file:-digit-ui-internals/Inbox.js at main · egovernments/digit-ui-internals
For further enquiry on how to set columns check out the link here- Getting Started: Overview
Code for the application details available here - digit-ui-internals/ApplicationDetails.js at main · egovernments/digit-ui-internals
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Mutation file link:
Similar to the MDMS used in employee Property Create flow and the Mutation Documents flow. Mutation documents MDMS data file link:
All content on this page by is licensed under a .
ULB | Total Records | Duplicate/Wrong data | % of data loadable after imposing assumptions | % of incorrect data |
---|
All content on this page by is licensed under a .
Url
Roles
Action Id
property-services/property/_update
PT-CEMP
1896
Url
Role
Action Id
/egov-location/location/v11/boundarys/_search
PTCEMP,FI,APPROVER,DV
1429
/property-services/property/_search
PTCEMP,FI,APPROVER,DV
1897
/billing-service/bill/v2/_fetchbill
PTCEMP,FI,APPROVER,DV
1862
/pt-calculator-v2/propertytax/v2/_estimate
PT-CEMP
1962
/property-services/property/_search
PT-CEMP
1897
/property-services/assessment/_create
PT-CEMP
1933
API
ROLES
ACTION ID
1
egov-mdms-service/v1/_search
954
2
access/v1/actions/mdms/_get
870
3
egov-workflow-v2/egov-wf/process/_count
EMPLOYEE
2027
4
egov-workflow-v2/egov-wf/process/_search
EMPLOYEE
1730
5
egov-workflow-v2/egov-wf/businessservice/_search
EMPLOYEE
1743
6
egov-workflow-v2/egov-wf/escalate/_search
EMPLOYEE
2168
Url
Roles
Action Id
property-services/property/_update
CITIZEN
1896
Url
Roles
Action Id
egov-workflow-v2/egov-wf/process/_search
PTCEMP,FI,APPROVER,DV
1730
/property-services/property/_search
PTCEMP,FI,APPROVER,DV
1897
/egov-workflow-v2/egov-wf/businessservice/_search
PTCEMP,FI,APPROVER,DV
1743
/filestore/v1/files/url
PTCEMP,FI,APPROVER,DV
1528
Url | Roles | Action Id |
|
|
|
Roorkee | 16363 | 500 | 97% | 3% |
Rishikesh | 2877 | 356 in the first sheet 261 in the second pass | 88% 91% | 12% 9% |
An illustrative guide to using the property tax module
The Property Tax (PT) module offers the citizens and governance bodies a convenient and transparent means of processing property taxes. Local governing bodies identify the applicable tax slabs for different types of properties. The PT module assesses properties, calculates tax amount, processes tax payment and generates tax collection reports.
The PT module enables citizens to pay property taxes online. It facilitates the governing bodies process property tax payments.
Refer to the table below to understand the different user roles and the scope of action linked to each role. The applicable user roles and action items can vary from one State to another. DIGIT customizes the workflows to suit the requirements defined at the State level.
This section guides you through the details of using the PT module for each role. Click on the relevant role below to learn more about how to use the PT system.
App to facilitate application for new W&S connections, pay bills, activate connections, generate bills
The Water & Sewerage module offers a consolidated platform for managing new and existing water and sewerage connections. The module eliminates the need for manual processing and streamlines the key water or sewerage management functions for operational efficiency. DIGIT Water & Sewerage (W&S) module enables automated processing of new connection requests, generating water bills, and facilitating online payment of bills.
DIGIT W&S module enables citizens to -
Apply for new sewerage or water connections
Upload documents required for processing new connections
Pay water or sewerage connection charges and bills using an online payment gateway
Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation
Download water or sewerage connection approval letter, payment receipts, and bills online
DIGIT W&S module enables employees at ULB and State level to -
Process applications using customizable workflows
Configure water and sewerage charges, interest, and penalty calculation logic
View custom dashboards for module statistics
Filter search results using advanced configurable search parameters
This section contains all docs and information required to understand the W&S module, its key features, functional scope, and configuration details. Click on the links below to learn more about deploying, configuring, customizing, and using the W&S module.
W&S Roadmap
Product Brochure
W&S Workflows
W&S Service Configuration
Demo Script
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
Find the list of Related Docs links at the bottom of each page to browse through additional product details
Reach out to us through any of the below-mentioned contact channels for any assistance or additional information on W&S module deployment.
#147/J, 1st floor, 10th Cross, 12th Main, 3rd Block, Koramangala, Bangalore 560034
+91 80 4125 5708
contact@digit.org
Learn how to add new property, assess or transfer property and pay property tax
Citizens represent individuals, communities, or business entities who are the system end-users. The PT module allows property owners to register their property details online. These details are then used for various property-related transactions.
The citizen can also approach the Counter Employee (CE) to register new property, assess property or pay property tax.
The Citizen or CE role can -
Alternate Mobile Number
Log in to the system. Click on Create Property option on the home page. This displays the Required Documents list. Note the list of documents that are valid for address, identity, registration, usage, special category, and occupancy proofs.
Click on Next to move on to the next screen. Answer Yes or No to the question Is this a Residential Property? Click on the Next button.
Select the relevant option on the screen to indicate the Type of Property.
Enter the Plot Size in square feet.
Select the correct option to indicate the Number Of Floors and the Number of Basements.
Enter the Ground Floor Details like Unit Usage Type, Occupancy, and Total Super Built-Up Area (sq ft). If the Occupancy type is Tenanted/Rented, enter the Total Annual Rent (INR) value.
Click on the Add One More Unit option to add G+1 or G+2 and additional floor details.
In case the Unit Usage Type is non-residential, enter the Sub Usage Type details to provide information on the type of business for which the property is used.
Provide the Pin Property Location on the map if you are at the building location while submitting the application for registration. You can Skip and Continue if you are not at the location.
Enter the Pincode of the area in response to the question Do you know the pincode? Click on Skip and Continue option if you do not know the Pincode.
Select the relevant City and the Locality from the drop-down list in the Provide Property Address screen to pinpoint the location of the property.
Enter the Street Name, Door/House No. of the property in the Provide Property Address screen. Enter a suitable Landmark detail in the Provide Landmark screen to identify the property location.
Choose the applicable Document Type as a declaration of the document you want to upload as Proof of Address. Click on the Choose File button to attach the scanned copy of the selected document. Select the applicable option in the Provide Ownership Details screen to indicate the ownership type of the property.
Enter details like Name, Gender, Mobile Number, Guardian and Relationship with the guardian in the Owner Details screen.
Select the applicable option in the Special Owner Category screen to indicate if the owner belongs to a specific category.
Enter the Owner's Address. Check the Same As Property Address box if the correspondence address of the owner is the same as the property address. The property address is auto-populated as the owner's address.
Select the applicable Document Type that you want to upload as Proof of identity. Click on Choose File button to attach and upload a scanned copy of the selected document.
Review your application details before submitting it. In case of any changes to the submitted details click on the Change button adjacent to the filled-in details.
Check mark the declaration box and then click on the Submit button. A success message is displayed along with the application no. and unique property ID. Click on the Download Acknowledgement Form button to download a copy of the acknowledgement.
Citizens access the citizen portal via the ULB portal and land on the home page displayed below. Click on the Search and Pay option on the property tax panel to search for a property and pay the property tax dues.
Note: Users can search and pay the property taxes even without logging in to the application.
Select one of the options on the screen to find the relevant property details -
I know my property ID - Select the City (mandatory) and input at least one of the 3 given parameters listed below -
Owner’s Mobile Number
Unique Property ID
Existing Property ID
I want to search using property details - Select the City (mandatory) and the Locality (mandatory). Enter at least one of the 2 given parameters listed below -
Door No.
Owner Name
Click on the Search button to fetch the list of the filtered properties. Click on the View Details button to see the tax details of the selected property and proceed with payment.
Verify the tax details displayed on the screen. Select Full Amount (the default option) to pay the full tax amount. Else, select the Custom Amount option to make a partial payment. Enter the Amount you are going to pay. Click on Proceed To Pay.
Select the applicable option on the Payer's Details page. In case the payment is being made on behalf of the owner/consumer of the service, enter the Payer's Mobile Number and Payer's Name. Click on the Next button to proceed with the payment.
Select Payment Method as appropriate and then click on Pay.
The payment transaction is completed by the payment gateway.
According to the response received from the payment gateway success/failure message is displayed. Click on the Download/View Receipt button to download the payment receipt.
Click on the Go back to home page link to navigate back to the home page.
Log in to the system to land on the home page and click on My Bills. All bills pending payment are displayed.
Click on View Details to see the tax details for the selected bill. Click on Proceed to Pay button to make the payment.
To view payment history and access details click on the My Payments option on the home page. This displays the entire list of payments made by the logged-in user.
Each payment card provides the following details:
Amount Paid
Property ID
Owner's Name
Receipt Date
Receipt Number
Click on the Download Receipt button to download and print the receipt.
Click on the My Properties option on the home page to view the registered properties for the logged-in user. It will display all the properties owned by logged in citizens.
Click on the View Details button to view the complete detail of the property. It will display the property detail.
Click on the My Applications option on the home page. This lists all the applications submitted so far for property tax services.
Click on the Track button to view the application details and its current status.
Click on the My Properties option on the home page. This displays the properties owned by the logged in citizen.
Click on the View Details button to see the detail of the selected property currently available in the municipal records. Click on the Update Property button to initiate an application to update the property details.
Follow the same steps as outlined in the Register New Property workflow to update the application.
A property can be transferred from person to person or from organization to organization or from organization to person or vice versa. The transfer can be on account of the property sale, gift, will, succession etc. Whenever such transfers happen the transferee is required to get the ownership change done in the municipal records.
To apply for a transfer of property ownership, click on Transfer Property Ownership/Mutation option on the home page. This redirects users to the Search Property screen. Enter the required parameters to search for the property.
Click on the Transfer Ownership button. The Required Documents - Transfer of Ownership provides the list of documents required for the application. Make sure these documents are scanned before proceeding with the application.
The Transferor Details show the current ownership details. Click on the Next button to proceed.
Enter Transferee Details. For the Provide Ownership Details section, select the applicable option to indicate the type of ownership.
In the Owner Details screen enter the owner Name, Gender, Mobile Number, Guardian and Relationship (relationship with the guardian) information.
Select the applicable option in the Special Owner Category screen.
Enter the correspondence address of the transferee in the Owner’s Address screen. Checkmark the Same As Property Address box if both addresses are the same.
Select the applicable Document Type in the Proof Of Identity screen. Click on Choose File button to attach the scanned copy of the document chosen above.
Select Yes or No to answer the question Is Mutation Pending In Court? If yes, enter the Details of Court Case.
Select Yes or No to answer the question - Is property or part of property under the state/central government acquisition? If yes, enter the Detail of Government Acquisition.
Select the applicable Reason for Property Transfer.
Enter the Property Market Value.
Enter the Registration Document No., the Registration Document Value, and the Registration Document Issue Date in the Registration Document Details screen.
Enter any additional Remarks (if required).
In the Registration Document Details screen, select the applicable Document Type. Click on Choose File button to attach and upload the scanned copy of the selected document.
In the Proof of Address screen select the applicable Document Type. Click on Choose File button to attach and upload the scanned copy of the selected document.
Click on Next. The application is submitted and a success message is displayed.
Click on the Download Acknowledgement Form button to download the acknowledgement form.
The update mobile number feature allows citizens and ULBs to change the existing mobile numbers to current numbers. The details are updated accordingly in the property owner records. Citizens can update their mobile numbers in the property details through an OTP validation.
Click on the My Properties option on the homepage. Search for the relevant property using search filters. Click on the View Details button for the applicable property.
Click on the Edit icon next to the Mobile Number on the Property Ownership Details page.
Enter the New Mobile Number on the screen. Click on the Send OTP button.
Enter the OTP received on the given mobile number and then click on Verify & Update Mobile Number button. In case of a wrong OTP entry, click on the Resend OTP button.
Refresh the Property Details page. The mobile number is updated.
This section illustrates the steps for different employee user roles at the ULB level
The citizen can approach the Counter Employee (CE) to register new properties, update property details, apply for title transfer or pay property tax.
The CE can
To search for submitted applications or track the status of submitted applications
Navigate to the Property Tax home page. Click on the Search Property link.
Select the Locality. The system displays the registered localities based on the ULB selected at the time of logging in.
Enter any of the following search parameters or combinations to refine the search for property - the Owner Mobile No. or the Unique Property ID allotted by the system or the Existing Property ID if there is any legacy ID linked to the property.
Click on the Search button to view the results. Click on the Clear Search button to renew the search with different parameters.
The search application facility enables users to search for an application.
Click on the Search Application option available in the employee inbox.
Enter at least one or multiple search parameters to find the application. The parameters are Application No., Owner Mobile No., Unique Property ID., Application Type, Application Status, From Date and To Date.
Search results show 10 records at a time on a page with the option to navigate to the next page.
Employee Inbox provides the option to search for applications in different states or workflow. Employees get a view of applications assigned to them for further processing.
Enter at least one or multiple parameters to refine the search for property applications. The parameters include Application No., Mobile No., and the Unique Property ID.
Click on the Search button to view the search results. The search results show the filtered list of property applications along with their status.
Other filters available to refine the view of applications are -
Assigned to Me
Assigned to All
Locality
Application Type
Click on the Unique Property ID hyperlink in the search list screen to access the details. Click on the Clear Search button to renew search parameters.
To collect the property tax, follow the steps outlined in Search Property to find the property. The search results display the property's Unique Property ID, Owner, Locality, Application Status, and Tax Due details.
Click on the Collect Tax hyperlink in the Action column for the specified property.
Verify the bill details. Click on Collect Payment to process the payment.
To view property details, follow the steps outlined in the Search Property to find the property. The search results display the Unique Property ID, Owner, Locality, Application Status, Tax Due and the Action details.
Click on the Unique Property ID hyperlink to view the corresponding property details.
Find the relevant property and click on the Unique Property ID to view the property details.
Click on the Payment History option available right below the Total Dues detail on the Property Information page. All payments made to date for the given property are displayed on the screen.
Click on the Download Receipt link available for individual cards to download the receipt in PDF format.
Citizens or CE can register new property details through the DIGIT web portal or the DIGIT mobile app.
To register a new property click on the Property Tax panel on the home page.
Click on the New Property Registration option on the panel. The new property application form page contains various sections that include Location Details Property Assessment Details, Ownership Details Document Required.
On the Location Details page enter the Pincode, City, Locality/Mohalla, Street Name, and Door/House No.
On the Property Assessment Details form enter the Property Usage Type, Property Type, and Plot Size details.
Enter the Floor/Unit details based on the selected Property Type. Select Floor, Usage Type, Occupancy, and Built-Up Area (sq ft) details. Click on the Add One More Unit option to add more unit details.
In the Ownership Details section, enter the owner's Name, Gender, Mobile Number, Guardian Name, Relationship, Special Category, Email, Correspondence Address, and Firm/Business Name.
In the Documents Required section upload the relevant documents for Usage Proof, Construction Proof, Occupancy Proof, Address Proof, Identity Proof, and Registration Proof.
Click on the Submit button once all the details are entered and documents uploaded. The application is submitted and the New Property Successfully Added acknowledgement message appears on the screen along with the Application Number and the Property ID details.
Click on the Download or the Print button on top of the page to download or print the application.
Edit property allows users to make changes to the property details. The system allows users to make partial edits too.
To make changes search and view the property details. Click on the Edit Property option in the Action column for the corresponding property. The following details can be edited for the property:
Only Street Name and Door No. can be edited in the Location Details.
All information can be edited in the Assessment Details.
None of the information allowed for edits in the Ownership Details.
Documents can be re-attached.
Follow the same flow as in New Property Registration to submit the changes.
Listed properties are assessed based on the changes to calculate the property tax amount.
To assess properties, find the property for assessment. Open the property details page and scroll down to click on the Take Action button. Click on the Assess Property option.
Select the relevant Financial Year in the pop-up window and then click on the Assess Property button.
The property tax assessment estimate details are displayed on the page. Click on the Assess Property button after reviewing the details.
The assessment is completed successfully. Click on the Proceed to Payment button to pay the property tax.
The PT module allows users to transfer the ownership of property.
To transfer the ownership of a property, search and open the property details page. Scroll down the page and click on the Take Action button. Click on the Transfer Property option.
Note the required documents for ownership transfer listed in the Required Documents - Transfer of Ownership screen.
Click on the Transfer Ownership button to proceed.
The Transferor Details page in the Transfer of Ownership form displays the current owner details.
Enter the following details in the Transferee Details form:
Provide Ownership Details - select the ownership type
Enter owner Name - the name of the transferee
Select the Gender of the transferee
Enter the Mobile No. of the transferee
Enter the Guardian’s Name of the transferee
Enter Relationship with Guardian of the transferee
Enter the Email address of the transferee
Select the applicable Special Applicant Category
Enter the Correspondence Address of the transferee
Select Yes or No option to answer the question Is Mutation Pending in Court? If yes, enter the Details of Court Case.
Select Yes or No option to answer the question Is Property or part of property under state/central government acquisition? If yes, enter the Detail of government acquisition.
On the Registration Details page provide the following questions:
Reason for Property Transfer
Property Market Value
Registration Document Value
Registration Document Issue Date
Remarks
Click on the Next Step button to proceed to the Document Upload section.
Select the type of document that will be uploaded for Address Proof, Identity Proof, and Registration Proof.
Click on the Next Step button to move to the Summary section. Click on the Submit button once all details are reviewed. The system displays the application success message. Click on the Download Acknowledgement button to download a pdf version of the acknowledgement.
Click on the Go back to home page button to navigate back to the home page.
To edit applications, navigate to the Inbox page. Search for the application you want to verify by entering any of the search parameters.
Scroll down the application page and click on the Take Action button. Click on the Edit option.
Update the application details and attached documents as required. Submit the application for subsequent processing.
To reopen the application find and open the desired application. Scroll down the application page and click on the Take Action button. Click on the Reopen option.
Select the Doc Verifier name who will be responsible for verifying the application. Enter any Comments if required. Click on the Choose File button to upload any file or images in context. Click on the Reopen button.
The application is forwarded to the selected doc verifier for verification of documents.
DV is responsible for verifying the supporting documents uploaded by the property applicants or the counter employee on behalf of the applicants.
The DV can
DV sends back the applications to the citizens if some vital information is missing in the application or there is a mistake in the information provided.
To send back applications to the counter employee, navigate to the Inbox page. Search for the application you want to verify by entering any of the search parameters. Click on the Take Action button available at the bottom of the page. Click on the Send Back To Citizen option.
Select the Assignee Name who will be responsible for verifying the application. Enter any Comments stating why the application is sent back. Click on the Choose File button to upload any files or images in context and then click on the Send Back To Citizen button.
The application is assigned back to the selected assignee for verification of documents and at the same time, the citizen is allowed to edit the application to update the missing details.
Property applications are rejected if the supporting documents uploaded by the applicant fails to comply with the property regulatory requirements or the details provided in the form are incorrect.
To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on Reject.
Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.
The applicant will receive a rejection notification on his mobile number or email address.
The DV verifies and forwards the property applications to the Field Inspector if the DV finds all information and documents provided by the applicant correct.
To verify and forward the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on the Verify and Forward button. Select the relevant Assignee Name from the list of available employees for subsequent processing.
Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Upload Files to upload any supporting documents for the application. Click on the Verify and Forward button.
The property application is assigned to the selected assignee for subsequent processing.
FI is responsible for inspecting and verifying the field details of the property in the application.
The FI can
FI sends back the applications to the citizens if some vital information is missing in the application or there is a mistake in the information provided.
To send applications back to the citizen navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on the Send Back to Citizen button. Enter any Comments stating why the application is sent back.
Click on the Choose Files button to upload any files or images in context to the application. Click on the Send Back to Citizen button.
The system displays a success acknowledgement message stating that the application is sent back to the initiator.
The FI can send back the PT application to the DV if there is any mistake or lapses in the document verification process.
To send back applications to the DV navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on the Send Back button.
Select the Assignee Name who will be responsible for verifying the application. Enter any Comments stating why the application is sent back. Click on the Choose Files button to upload any files or images in context. Click on the Send Back button.
The application is assigned back to the selected assignee for verification of documents.
Property tax applications are rejected if the supporting documents uploaded by the applicant fails to comply with the license requirements or the details provided in the form are incorrect.
To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on Reject.
Enter your Comments to state the reason for rejection. Click on the Upload Files button to upload any supporting documents to validate the rejection. Click on the Reject button.
The applicant will receive a rejection notification on his mobile number or email address.
The FI verifies and forwards the property applications to the Approver if the information and documents provided by the applicant are correct.
To verify and forward the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on the Verify and Forward button. Select the relevant Approver name from the list of available employees for subsequent processing.
Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Choose Files to upload any supporting documents for the application. Click on the Forward button.
The property application is assigned to the selected assignee for subsequent processing.
The Approver is responsible for the final approval of the PT application.
The Approver can
The Approver can send back the property applications to the citizen if there is any mistake or lapses in the application.
To send back applications to the citizen navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on the Send Back To Citizen button.
Select the Counter Employee name who will be responsible for verifying the application. Enter any Comments stating why the application is sent back. Click on the Choose Files button to upload any files or images in context. Click on the Send Back To Citizen button.
The application is assigned back to the citizen for verification of the application.
The Approver can send back the property applications to the FI or DV if there is any mistake or lapses in the document verification process.
To send back applications to the DV or FI navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on the Send Back button.
Select the Field Inspector Name who will be responsible for verifying the application. Enter any Comments stating why the application is sent back. Click on the Choose Files button to upload any files or images in context. Click on the Send Back button.
The application is assigned back to the selected assignee for verification of the application.
Property applications are rejected if the supporting documents uploaded by the applicant fails to comply with the regulatory requirements or the details provided in the form are incorrect.
To reject applications navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on Reject.
Enter your Comments to state the reason for rejection. Click on the Choose Files button to upload any supporting documents to validate the rejection. Click on the Reject button.
The applicant will receive a rejection notification on his mobile number or email address.
The Approver signs off the PT application once the information and documents provided by the applicant are found correct.
To approve the application navigate to the Home page. Search for the application you want to verify by entering any of the search parameters. Click on Application No. to open the application. Scroll down the form to review the filled in details.
Click on the Take Action button available at the bottom of the page. Click on the Approve button.
Enter any additional information in the Comments field in context to the application for the assignee’s knowledge. Click on Choose Files to upload any supporting documents for the application. Click on the Approve button.
The property application is approved.
The DIGIT W&S module facilitates citizens to apply for water and sewerage connections online and pay their bills too. The module supports municipal bodies with automated processing of citizen applications, bill generation and overall management of water and sewerage connections.
Functional overview for stakeholders
The Water and Sewerage (W&S) module provides a digital interface to apply for water and sewerage connections and, pay the water and sewerage charges for connection/s. It can be used by the citizens, Urban Local Body (ULB) counter employees and field employees, and ULB Administrators to accomplish their specific tasks. It is available as a mobile and web-based application.
The Water and Sewerage product features can be broadly classified as the following modules:
Registration, Login and Creation of User Profile
Applying for a new Water/Sewerage connection
Searching for a Connection
Modifications to a Connection
Entering meter reading of metered connections
Generate Demand
Payment collection and Receipts
Closure of water connection
Dashboards and Reports
This module provides enables the following capabilities
OTP Based Login for Citizen via Web/Mobile App
OTP Based Login for Employee via Web/Mobile App
Provision for language selection during first time registration for both Employee and citizens
Provision of creating a personalized Profile for Citizens and employees on Web App
Login Credentials for the various hierarchy of employees
Role-based access for performing different actions relating to the W&S module
The system allows the Citizen / ULB user (with an appropriate role in the system) to apply for a New Water/Sewerage connection. The application goes through an approval workflow before it is available for various transactions in the system. The workflow to be followed for a new water/sewerage connection is configurable. In the workflow, the ULB official will generate the estimation notice. Once the payment is made, a work order will be generated.
Every time there is a change in the status of an application, the citizen will be intimated through in-app notifications, SMS and email. The citizen and employee can view the history of the various states that an application has been in and the comments added by the employee in each state of the application.
The employee from the W&S department will be able to access the feature, to search for water and sewerage connections. They can search for any connection based on parameters such as:
Consumer number
Application number
Owner mobile number
Application status
From date
To date
The search result contains, Application number, Consumer number, Owner name, Status, Due amount and Pay now option. The Employee can make payment for a connection on the citizen’s behalf using the ‘Pay Now’ option.
Citizens can also search for their connection in the portal. They can search using the Owners mobile number, Property ID, Consumer number etc. The search result yields, Owner’s Name, Address, Due amount and Pay option.
The system facilitates the title transfer of water tap connection from one person to the other person. Title transfer of water tap connection directly depends upon Property tax. If title transfer is done in the property tax module then at the time of final approval, the changes will reflect in the W&S module automatically. After the title transfer has been completed successfully, subsequent bills will be generated with the details of the new owner/s.
Water tap change in usage happens when property type is changed from residential to Non-residential or from Non-residential to residential. Change in usage directly depends on the property tax module. If the property type is changed in the Property tax system then it will automatically reflect in the W&S system. When there is a change in the usage type, the subsequent bills will reflect the rates as per the updated usage category. When there is a change in the usage category in the middle of the billing cycle, pro-rata charges will be applied in the next billing period.
The change in connection category from non-metered to metered and vice-versa is also possible in the W&S system with the appropriate workflow configured to intimate all stakeholders of the change and collect any charges (if applicable) from the citizen.
On the W&S billing screen, there is a card called ‘Meter reading’. An employee can click on ‘Meter reading’ which redirects the employee to the meter reading landing screen. The employee can search based on the following criteria:
ULB
Boundary Type
Boundary Value
Billing Year
Billing Period
Billing Period Value
Consumer No.
This feature facilitates the employee to search for all results based on desired criteria. The search result yields the following values: consumer number, owner name, meter status, last reading, current reading, date and consumption.
The employee can edit meter status, current reading, date and consumption under certain conditions. Based on this information the employee can generate the bills for connections.
In the system, there is a feature to generate demand under the billing section. Generate demand has a search feature in which, the connections can be searched for which demand has been already generated. An employee can view, also edit those demands based on certain conditions.
The system has the capability to configure the demand generation as an automatic or a manual process. In the automatic process, the demand generation for non-metered connections is automatically done periodically. For metered connection as soon as the employee enters the meter reading and clicks on ‘SAVE’, the demand is generated.
Any success/ failure to generate demand triggers an automatic notification to the concerned ULB officials via email. Also, the demand generation cycle, demand generation date and officials who should receive the notifications can be configured.
The citizen can pay for dues by searching his/her connection. In search results, the citizen can click on pay, which redirects to the summary page of the dues. After this, the citizen can pay for dues online. An employee can also collect the payment on the citizen’s behalf. After searching for the desired connection, clicking on pay will redirect the employee to the common payment page. The employee can print the receipt after the payment is successfully collected. The citizen is also notified and gets a download receipt link in the notification.
If the Water tap owner has got his own water source then the water tap owner can initiate for Water tap connection closure permanently. So, that tap will be closed permanently and demand would not be generated for the connection. Application for the closing of water tap connection is accepted only with the latest water charges receipt and clearing of old dues.
The state-level administrator can keep track of relevant metrics by using dashboards. Dashboards for W&S can be accessed by a state-level user under login. The dashboard has these components:
Financial Indicators
W&S Total collections YTD
Water Collection
Sewerage Collection
Water - Demand vs Collection (Monthly trend)
Sewerage - Demand vs Collection (Monthly trend)
Municipal Adoption
W & S : No. Of ULBs Live
W & S: Total Number of ULBs
Water Consumers by Connection Type
W & S Consumers by Usage Type
Total Collections by Source
Total Collections by Mode
W & S Adoption : ULB Wise
Today’s Collections
W&S Total collections: Today
Water Charges - Total collections: Today
Sewerage Charges - Total collections: Today
W&S - Total No. of Receipts: Today
Water - Total No. of Receipts: Today
Sewerage - Total No. of Receipts: Today
Mode wise W&S collections: Today
W&S ULB wise collections: Today
The table below lists the functionalities supported by the offered product as per the recommendations under the guidelines mentioned under the Ease of Doing Business (EODB) guidelines of 2019.
We are using re-indexing to get all the data to the respective indexer. We have 2 steps for this. The first is to run the connector from the playground. This is followed by a legacy indexer service call from the indexer service, which internally calls the respective plain search service to get the data and send it to the respective indexer.
Access to kubectl of the environment targetted
Postman scripts
Plain search APIs in the respective services
We have two services for water and sewerage
water-services
sewerage-services
Connect to playground pod.
Delete the Kafka connector if already exists with the Kafka connection, using the below command through playground pod.
Run below Kafka connector curl from playground pod:
port forward to egov-indexer pod and run below curl throw postman.
Delete the Kafka connection after all the data has been re-indexed by following the below command through the playground pod.
Alias water-services-enriched as water-services through the Kibana server.
Connect to playground pod.
Delete the Kafka connector if already exists with the Kafka connection, using the below command through playground pod.
Run below Kafka connector curl from playground pod:
port forward to egov-indexer pod and run below curl throw postman.
Delete the Kafka connection after all the data has been re-indexed by following the below command through the playground pod.
Alias water-services-enriched as water-services through the Kibana server.
For the offered product, the implementation process can be divided into six major distinctive stages. Each stage has predefined entry and exit criteria, roles & responsibilities to assure objective monitoring and decision-making for the overall success of the engagement. The whole implementation lifecycle is typical of 23-27 weeks for the State/UT keeping in mind the entry, and exit criteria defined at the beginning and end of each stage are met on time recommended.
Implementation of Water and Sewerage (W&S) requires meticulous planning and close coordination between various stakeholders at the centre and State/UT levels. The success of the initiative is dependent upon many factors like strong Program governance, availability of trained resources, financial planning, targeted implementation Team onboarding, focus on last-mile capacity building and ensuring necessary support to the urban centre. Achievement of all these factors will provide the most effective and efficient roll-out and adoption of the Water and Sewerage Implementation System in the UT.
The Water and Sewerage (W&S) module provides a digital interface to apply for water and sewerage connections and pay the water and sewerage charges for connection/s. The citizens can use it, Urban Local Body (ULB) counter employees and field employees, and ULB Administrators to accomplish their specific tasks. It is available as a mobile and web-based application. The W&S product features can be broadly classified as the following modules:
Registration, Login and Creation of User Profile
Application for new Water/Sewerage connection
Searching for a Connection
Modifications to a Connection
Entering meter readings of metered connections
Generate Demand
Payments collection and Receipts
Dashboards and Reports
This module provides enables the following capabilities:
OTP-based login for citizens via Web/Mobile App
OTP-based login for employees via Web/Mobile App
Provision for language selection during first-time registration for both employees and
citizens
Provision of creating a personalized profile for citizens and employees on the Web App
Login credentials for the various hierarchy of employees
Role-based access for performing different actions relating to the W&S module
The system allows the Citizen / ULB user (with an appropriate role in the system) to apply for a New Water/Sewerage connection. The application goes through an approval workflow before it is available for various transactions in the system. The workflow to be followed for a new water/sewerage connection is configurable. In the workflow, the ULB official will generate the estimation notice. Once the payment is made, a work order will be generated.
Every time there is a change in the status of an application, the citizen will be intimated through in-app notifications, SMS and email. The citizen and employee can view the history of the various states that an application has been in and the comments added by the employee in each state of the application.
Only employees from the W&S department will be able to access the feature, to search for water and sewerage connections. They can search for any connection based on parameters such as:
Consumer number
Application number
Owner mobile number
Application status
From date
To date
The search result contains the Application number, Consumer number, Owner name, Status, Due amount and the Pay now option. The Employee can make payment for a connection on the citizen’s behalf using the ‘Pay Now’ option.
Citizens can also search for their connections in the portal. They can search using the Owners mobile number, Property ID, Consumer number etc. The search result yields, the Owner’s Name, Address, Due amount and Pay options.
The system facilitates the title transfer of the water tap connection from one person to the other person. Title transfer of water tap connection directly depends upon Property tax. If title transfer is done in the property tax module then at the time of final approval, the changes will reflect in the W&S module automatically. After the title transfer has been completed successfully, subsequent bills will be generated with the details of the new owner/s.
Water tap change in usage happens when the property type is changed from residential to Non-residential or from Non-residential to residential. Change in usage directly depends on the property tax module. If the property type is changed in the Property tax system then it will automatically reflect in the W&S system. When there is a change in the usage type, the subsequent bills will reflect the rates as per the updated usage category. When there is a change in the usage category in the middle of the billing cycle, pro-rata charges will be applied in the next billing period.
The change in connection category from non-metered to metered and vice-versa is also possible in the W&S system with the appropriate workflow configured to intimate all stakeholders of the change and collect any charges (if applicable) from the citizen.
On the W&S billing screen, there is a card called ‘Meter reading’. An employee can click on Meter reading which redirects the employee to the meter reading landing screen. The employee can search based on the following criteria:
ULB
Boundary Type
Boundary Value
Billing Year
Billing Period
Billing Period Value
Consumer No.
This feature facilitates the employee to search for all results based on desired criteria. The search result yields the following values: consumer number, owner name, meter status, last reading, current reading, date and consumption.
The employee can edit meter status, current reading, date and consumption under certain conditions. Based on this information the employee can generate the bills for connections.
In the system, there is a feature to generate demand under the billing section. Generate demand has a search feature in which the connections can be searched for which demand has been already generated. An employee can view, also edit those demands based on certain conditions.
The system has the capability to configure the demand generation as an automatic or a manual process. In the automatic process, the demand generation for non-metered connections is automatically done periodically. For metered connection as soon as the employee enters the meter reading and clicks on ‘SAVE’, the demand is generated.
Any success/ failure to generate demand triggers an automatic notification to the concerned ULB officials via email. Also, the demand generation cycle, demand generation date and officials who should receive the notifications can be configured.
The citizen can pay for dues by searching his/her connection. In search results, the citizen can click on pay, which redirects to the summary page of the dues. After this, the citizen can pay for dues online. An employee can also collect the payment on the citizen’s behalf. After searching for the desired connection, clicking on pay will redirect the employee to the common payment page. The employee can print the receipt after the payment is successfully collected. The citizen is also notified and gets a download receipt link in the notification.
If the Water tap owner has got his own water source then the water tap owner can initiate for Water tap connection closure permanently. So, that tap will be closed permanently and demand would not be generated for the connection. Application for the closing of the water tap connection is accepted only with the latest water charges receipt and clearing of old dues.
The state-level administrator can keep track of relevant metrics by using dashboards. Dashboards for W&S can be accessed by a state-level user under login.
The dashboard has these components:
Financial Indicators
W&S Total collections YTD
Water Collection
Sewerage Collection
Water - Demand vs Collection (Monthly trend)
Sewerage - Demand vs Collection (Monthly trend)
Municipal Adoption
W & S: No. Of ULBs Live
W & S: Total Number of ULBs
Water Consumers by Connection Type
W & S Consumers by Usage Type
Total Collections by Source
Total Collections by Mode
W & S Adoption: ULB Wise
Today’s Collections
W&S Total collections: Today
Water Charges - Total collections: Today
Sewerage Charges - Total collections: Today
W&S - Total No. of Receipts: Today
Water - Total No. of Receipts: Today
Sewerage - Total No. of Receipts: Today
Mode-wise W&S collections: Today
W&S ULB wise collections: Today
This section provides an overview of the methodology for the State-wide implementation of W&S. The Implementation of W&S is distributed across seven distinct stages. Each stage has predefined entry & exit criteria and roles & responsibilities. This is to ensure objective monitoring and decision-making for the overall success of the program. Details of each stage are defined in this section.
Note: This document is specific for States that have more than 30 ULBs.
W&S implementation program is expected to be completed approximately between 38- 42 weeks with the resource deployment by the State and System Integrator (SI) Team (as defined below). However, it is critical that activities and exit criteria set for each stage are achieved to adhere to this timeline.
There is a set of initial critical activities that are undertaken upon receiving a letter of enrollment from the State/Union Territory. Successful completion of these activities assures that the program is started with crucial personnel, System Integrator(SI) teams and funds.
Define the value proposition of the programme for the state
Define the time frame within which the state needs to:
Go live
Scale pan-state
Define Year-on-Year(YoY) Financial Targets
System Integrator(SI) Sign-up:
System Integrator and state will agree on program scope, program timelines, and budgeting & resourcing.
This stage envisages the in-person interaction of crucial State/UT officials and implementation System Integrator(SI) Teams to kick-start the program. This stage may require multiple interactions/meetings with different stakeholders. The principal objective of these interactions is to identify scope, plan strategies for phasing/rollout (in pilot ULBs/Pan State) and create an active collaboration & Governance approach and agree on a high-level timeline for the engagement.
Note
1) State Baseline Data (As per the Module): A Baseline Template is provided to collect certain vital information like no. of transactions, revenue collected in the last FYs, collection mode, budget data, etc. This data is vital for various analyses at the state level. This data must be collected pre-rollout. The baseline data collection templates will be provided to the state/SI Team.
2) ULBs Specific Product Data Configuration: This Master data is required from the Product Perspective to go live. For eg: Connection Legacy Data, Boundary Data, List of Employees, Rates etc. Master Data Template will be provided for the collection of this particular data type.
During the Solution design stage, key State/UT officials and members, who are subject matter experts, are expected to share State/UT acts and policies and help interpret the same for the System Integrator (SI) Team. This stage baselines the State/UT-specific product features in the Product Configuration report.
This stage consists of a series of developments in accordance with the detailed project plan to ensure the smooth functioning of the customised product. Preparation for the testing and data collection of the product UAT is complete. Further monitoring and maintenance strategies are put in place.
During this stage, a demonstration of the product followed by a hand on session is conducted for the ULB officials. Necessary training of ULB officials and resources required for UAT is conducted and identified respectively. The establishment of the State/UT support Team and required processes are initiated in this stage.
On successful Go-Live in the Pilot ULBs, after further configurations to stabilize the product, the solution will be rolled out to the rest of the ULBs in multiple phases. Guidance and support from the State/UT Team will be required to create the rollout plans and assure the necessary infrastructure for training and deployment is available at each ULB.
Note: The rollout phase needs to be detailed out for iterative activities of onboarding ULBs in batches.
Note: Only once all the stages are complete in one batch of the rollout of around 30 ULBs, the next batch begins. There are multiple phases of rollout. The second batch begins after the first batch has successfully fulfilled all the criteria of the Rollout Phase. Typical timelines for closure of rollout in each batch is 5-6 weeks (in a batch of 30 ULBs).
The final stage consists of strategies to ensure the sustenance of the product in the State/UT. Systems are put in place to ensure the continuous tracking of data and provisions are made to improve the product if new data suggest.
This section outlines the activities involved in each stage of the implementation along with the responsibility and accountability of critical stakeholders - UT, NUS Team and System Integrator Team onboard.
W&S Cell: W&S Cell is the government-appointed body chaired by the Principal Secretary/Secretary, Urban Development Department with members from Urban Development Department etc.
Resource requirements for the W&S cell required to be formed by the UT
Note: The designation mentioned above is as per designations known to drive W&S implementation at the State/UT level (explained below). These are the preferred figures in the case of Domain Expert, 2 people are subject to availability.
Project Head: Is the Head of the W&S Cell who will drive the project from the State/UT Side
Domain Expert: A person who is well aware of the on-ground scenario, well versed with the act, GOs passed, Prevalent Business processes, Deviations from the acts, Rates/ slabs applicable
Nodal officer (EO/Commissioner/ Senior Official): the product coordinator to drive the project centrally; monitors usage post Go Live; point of escalation for Implementation Team; seasoned and worked in multiple ULBs on various modules and has a good understanding of W&S; facilitates and tracks data collection post-go-live; monitors and facilitates the adoption of the application; point of contact for eGov, SI and at the HQ level.
MIS Expert: Day-to-day tracking of the program, data entry, reporting and review to senior officials
eGov Team: eGov Team is the technical partner of the project which will provide all necessary support to the State/UT concerning the implementation, Program Designing etc.
System Integrator (SI) Team: SI Team will be responsible for the rollout of the initiative in the UT, providing end-to-end support to the State/UT w.r.t. The implementation of the products in the ULBs.
Guidelines to read the table are mentioned on the next page:
Execute - One who owns the accountability to complete the activity
Consult - One who may initiate, guide and in the process, handhold the execution of the activity
Note: Stage 0 is where the W&S cell and SI team are formed, hence there are only two entities playing a role which are that of eGov and the state leadership. Once the W&S cell and SI team are finalized, their role begins in the following stages.
Vision: Defining the time frame to go live, the time frame to scale it pan state, the value proposition of the programme for the state and year-on-year financial targets and adoption targets
Project Plan: A detailed plan of program schedule/timelines, implementation phases, team structure and ongoing support and maintenance required.
System Integrator: The entity/company which collates all the subsystems required for the project and integrates them to achieve the program objective
Program Charter: Outline of implementation plan agreement with priority applications and broad timelines, program governance model, program success metrics and capacity building.
Acceptance Letter/MOU: Formal acceptance/sign-off of the client state with a clear mandate of the program
Program Success Metrics: Defining the parameters (which are measurable) prior to the program, on which the success of the program is to be measured on the completion of the program
Project steering committee: The key body within the governance structure which is responsible for the business issues associated with the project that are essential in ensuring the delivery of the project outputs and the attainment of project outcomes.
Project governance: Set of policies, regulations, functions, processes, procedures and responsibilities that define the establishment, management and control of projects, programmes and portfolios.
Scoping: List of activities measured against the time taken to complete them in accordance with the project goals
Baseline data: Set of information that serves as a foundation to compare other data acquired afterwards
Project Kick-off meeting: Meeting with the project team and the client of the project. This meeting would follow the definition of the base elements for the project and other project planning activities
Fitment Study: GAP study of the existing/required field process vs product
Data migration: Existing records of the functional activities need to be moved into the database of the newly released application
Data collection: Required data for the roll-out of the applications, which needs to be collected from the existing functional process
Data validation approach: This approach enables the sanctity of the data with built-in validation by design
Data synchronization: The process of establishing consistency among data from a source to a target data storage and vice versa and the continuous harmonization of the data over time.
Pilot Implementation: Any new process is tested out as a pilot in one or two instances before pan implementation.
Pilot ULB: The ULBs selected for the pilot implementation are called pilot ULB.
Roll out: On successful clearance of the pilot, the process/application/services are implemented across all Offices/ULBs.
Deployment: Deployment defines the complete package of software components set up in a particular environment.
Customisation: Details of changes to be made in the product to comply with the needed field process.
Configuration: Defining existing content such as options and variables based on the requirements on the ground
Product walkthrough: Explaining the users step-by-step through a set of actions that they need to take to achieve a specific outcome.
Water service is the eGov application, which helps and gives flexibility to municipalities and citizens to handle the water service like applying for the water connection and searching for water connections. The application goes through different stages that the states identify for given roles. If that role takes the action then the application goes to the next state. Based on the state, a citizen gets a notification (SMS and in-app ). Citizens also can pay for application fees or employees can collect the fee for the application.
Before you proceed with the documentation, make sure the following pre-requisites are met -
Java 8
The 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
knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-sms, eGov-email,eGov-user, eGov-localization, eGov-workflow-service will be helpful.
Apply for a water connection.
Searching for water connections.
Apply for property creation.
Can take different actions based on state (Workflow)
Notification based on the application state.
To Do
Table UML diagram
master-config.json for water service
Actions
Role Action Mapping
Create businessService (workflow configuration) using the __/businessservice/_create. Following is the product configuration for the water service.
Workflow for property creation through Water and Sewerage module
Setup
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.
Run the egov-indexer app, Since it is a consumer, it starts listening to the configured topics and indexes the data.
Modify connection
After connection activation or legacy connection, we can edit the connection. This process is based on a defined workflow. Any action is based on defined roles on the action level. For the edit connection, we need to upload some supporting documents and mandatory info.
Workflow config for edit connection
Create businessService (workflow configuration) using the __/businessservice/_create. Following is the product configuration for editing the water connection.
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 who 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 connector 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 in their road type details and road cutting area. Based on this information, the application one-time fee estimate is calculated.
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 APIs.
Create businessService (workflow configuration) accordingly for trade water connection, modify water connection
Add ws-service indexer yaml path in indexer service configuration and restart indexer service.
This ws-service module is used to manage water service connections against a property in the system.
Provide backend support for the different water connection registration processes.
Mseva and SMS notifications on application status changes.
Elastic search index for creating visualizations and Dashboards.
Supports workflow which is configurable
To integrate, a host of ws-service modules should be overwritten in the 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
/ws-services/wc/_update should be added as the update endpoint. This method is used to update fields in existing records or to update the status of the application based on workflow.
(Note: All the APIs are in the same postman collection therefore the same link is added in each row)
User Role | Scope of Action | Role Description |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Reform Area | Weightage (score) | Recommendation | Remarks |
---|
All content on this page by is licensed under a .
Access to clean and safe water is one of the basic needs of citizens. Each Urban local body has been mandated with catering to the water and sanitation needs of its citizens. The computerized and automatic Water and Sewerage system offered by eGov enables citizens who seek to apply and pay for water and sewerage connections within any Urban Local Body with a transparent, speedy, hassle-free and user-friendly procedure. The ULB officials can now sanction connections, generate bills and collect payments for water and sewerage connections more efficiently. (For details on product features refer to )
Stage Zero-program setup and onboarding is a pre-requisite for the initiative to kick off and requires setup of the governance model, implementation team and decision regarding other significant elements of the initiative like funding and procurement process. Stage One of the initiative requires scoping the initiative and deciding on the priorities for implementation by the State/UT Implementation Team. In Stage Two, the W&S team is appointed and its processes are standardized. In Stage Three, the State/UT Team will work on identifying and finding solutions to the significant gaps in the product offered w.r.t. to the need of the State/UT. Configuration and customization of the product is the primary objective of Stage Four. This involves working on various aspects of UT-specific needs and incorporating them into the product suite offered. In Stage Four and Five, post doing UAT and including all the necessary feedback on the product, the roll-out of the product is done at the State/UT level(Go Live) from a couple of ULBs to pan State/UT coverage. In Stage Six of sustenance and ongoing improvement, key activities are adoption and governance tracking with the planning of ongoing sustenance. (For details on the implementation plan refer to ).
Stage 0 - Program Setup/ On-Boarding |
---|
Stage 1 - Program kick-off |
---|
Stage 2 - Solution Design |
---|
Stage 3 – Configuration & Customization |
---|
Stage 4 – UAT & Go Live |
---|
Stage 5 – Rollout |
---|
Stage 6- Sustenance and Ongoing Improvement |
---|
Resource Name | No. Of Resources |
---|
Stage 0 - Program Setup/ On-Boarding |
---|
Stage 1 - Program kick-off |
---|
Stage 2 - Solution Design |
---|
Stage 3 – Configuration & Customization |
---|
Stage 4 – UAT & Go Live |
---|
Stage 5: Rollout |
---|
Stage 6- Sustenance and Ongoing Improvement |
---|
Areas | Assumptions |
---|
All content on this page by is licensed under a .
Environment Variables | Description |
---|
``
Property creation through WNS module
The indexer provides the facility for indexing the data to elastic search.
Write the configuration for the water service.
Put the indexer config file into the config repo under egov-indexer folder. ( )
Title | Link |
---|
Title | Link |
---|
All content on this page by is licensed under a .
Citizen
Add Property
Search Property
Edit Property
Assess Property
Re-Assess Property
Pay Property Tax
Transfer Property Ownership
Download Receipts/Applications
Individuals and Community groups
Counter Employee (CE)
Add Property
Search Property
Edit Property
Assess Property
Re-Assess Property
Pay Property Tax
Transfer Property Ownership
Download Receipts/Applications
Counter employees who assist citizens register new property details, transfer ownership of property, pay property tax on their behalf
Document Verifier (DV)
Verify and forward
Send Back
Edit Application
Employees responsible for verifying the supporting documents submitted by citizens for a new property or transfer of ownership of property
Field Inspector (FI)
Verify and forward
Send Back
Reject
Edit
Employees who go on to the field (i.e. location of property) and physically verifies the information provided by the applicant is correct
Approver
Approve
Send Back
Reject
Cancel
An employee who has the final authority to approve or reject the property registration
Obtaining Utility Permits | 1 | Obtaining Water Connection | Implement an online application system with the following features: i. Online submission of application without the need to submit a physical copy of the application ii. Eliminate physical touchpoint for document submission iii. Allow the option of online payment of application fee iv. Allow the applicant to track the status of the application online ( Available in DIGIT Platform) |
Obtaining Utility Permits | 1 | Obtaining Water Connection | Display information on tariffs (in Rs. per kL) and notify customers of the change in tariff ahead of the billing cycle (for commercial and industrial users) ( Available in DIGIT Platform) |
Obtaining Utility Permits | 1 | Obtaining Water Connection | Allow users to pay water bills online ( Available in DIGIT Platform) |
Duration | 4-6 weeks |
Entry Criteria | Acceptance Letter/MoU by State |
Exit Criteria |
|
Duration | 4-6 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 4-6 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 6-8 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 2-3 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria |
|
Duration | 5-6 weeks |
Entry Criteria |
|
Key Activities |
|
Exit Criteria | State/UT wide Rollout in batches:
|
Duration | Ongoing process |
Entry Criteria |
|
Key Ongoing Activities |
|
Project Head | 1 |
Domain Expert | 2 |
Nodal Officer | 2 |
MIS Expert | 4 |
Task/Activity | eGov | State Leadership |
Appoint W&S Cell | Consult | Execute |
Finalize funding for the program | Consult | Execute |
Define state/UT-specific procurement process | Consult | Execute |
System Integrator(SI) Team sign-up/onboarding | Consult | Execute |
Finalize Water and Sewerage Program Vision | Consult | Execute |
Task/Activity | eGov | W&S Cell | SI Team |
Identify & agree on scope and exclusions | Consult | Consult | Consult |
Identify pilot ULBs | Execute | Consult |
Project kick-off meeting and stakeholders consultation | Execute | Consult |
Product Walkthroughs | Consult | Execute |
Define Project Steering Committee structure and Project Governance process | Consult | Consult | Execute |
Define phases of deployment/ rollout | Consult | Consult | Execute |
Agreement on Product Feature Priorities and high-level delivery timelines | Consult | Execute |
Assessment of all W&S process along (1) citizen services/channels around it (2) Integration with other department processes | Consult | Execute |
Finalize Program Success Metrics for Adoption and Governance adhering to the vision of the program | Consult | Execute |
Internal Capacity Building, program logistics at State and ULBs, as per the current scenario | Execute | Consult |
Task/Activity | eGov | W&S Cell | SI Team |
Standardisation of all W&S processes, if needed | Consult | Execute |
Initiate policy change and Process Re-engineering, if needed based on identified improvements | Consult | Execute | Consult |
Conduct Product familiarization workshop | Consult | Consult | Execute |
Initiate collection of master data from pilot ULBs | Consult | Execute |
Finalize data migration/collection/sync-up approach | Consult | Execute |
Finalize data validation approach | Execute | Consult |
Building capacity for basic understanding of resources and tools required to be used | Execute | Consult |
Task/Activity | eGov | W&S Cell | SI Team |
Setting up development environments | Consult | Execute |
Development/customization of reports and dashboards | Consult | Execute |
Development/Integration of portal | Consult | Execute |
Third-Party Integrations (Payment gateway, Handheld/pos device) | Consult | Execute |
Updation of user manuals and other key documents | Consult | Execute |
Preparation & execution of Test Cases | Consult | Execute |
Setup monitoring, support & maintenance processes, tools and dashboards | Consult | Execute |
Data Migration for Pilot ULBs(at least) | Consult | Execute |
Training for basic understanding of resources and tools required to be used (system-related) | Execute | Consult |
Legacy Data Validation signoff from the state on Data Validation | Execute | Consult |
Task/Activity | eGov | W&S Cell | SI Team |
UAT Environment Setup | Consult | Consult | Execute |
UAT Testing | Consult | Execute |
Issues/bug resolution | Consult | Execute |
UAT Sign off from Pilot ULBs | Execute | Consult |
Setting up the Production environment | Consult | Execute |
Setting up Support Center & processes (Help Desk) | Execute | Consult |
Training (Users, trainer) | Execute | Consult |
Training the Support Resources | Consult | Execute |
Marketing & promotion activities | Execute | Consult |
Go Live & launch event | Execute | Consult |
Setup of review and monitoring cadence/team Usage/ review/Dashboard/Field Visits | Execute | Consult |
Task/Activity | eGov | W&S Cell | SI Team |
ULB configurations | Consult | Execute |
Phase wise Migration and verification of ULB data | Execute | Consult |
Logistics planning for training | Execute | Consult |
Training the Users at the district level | Execute | Consult |
Roll Out - All Locations | Consult | Execute | Execute |
Stabilize product | Consult | Execute |
Task/Activity | eGov | W&S Cell | SI Team |
Adoption Review Meetings as per the vision defined for the program | Consult | Execute | Consult |
W&S Cell Focuses on Using data for:
| Execute | Consult |
Conduct Weekly Review Meeting between ULBs, State Team for feedback on the system, which must be chaired by the Program Head | Execute | Consult |
Plans of ongoing Sustenance in Place with respect to :
| Consult | Execute | Consult |
Infrastructure |
|
Project Scope |
|
State Team |
|
Documentation |
|
Training |
|
Implementation |
|
egov.waterservice.createwaterconnection | This variable contains the kafka topic name which is used to create new water connection application in the system. |
egov.waterservice.updatewaterconnection | This variable contains the kafka topic name which is used to update the existing water connection application in the system. |
egov.waterservice.updatewaterconnection.workflow.topic | This variable contains the kafka topic name which is used to update the process instance of the water connection application. |
egov.idgen.wcapid.name | This variable contain the idgen format name for water application |
egov.idgen.wcapid.format | This variable contain the idgen format for water application ex:- WS/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON] |
egov.idgen.wcid.name | This variable contain the idgen format name for water connection |
egov.idgen.wcid.format | This variable contain the idgen format for water connection ex:- WS_AP/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON] |
API Swagger Documentation |
Water Calculator Service |
/ws-services/wc/_create |
/ws-services/wc/_update |
/ws-services/wc/_search |
Water Calculator Service is used for creating meter reading, searching meter reading, updating existing meter reading, calculation of water charge, demand generation, SMS & email notification to ULB officials on-demand generation and estimation of water charge(one-time cost) which involves cost like road-cutting charge, form fee, scrutiny fee, etc.
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 water service persister configs path added in it
PSQL server is running and a database is created to store water connection / application data
Following services should be up and running:
egov-perister
egov-mdms
ws-services
billing-service
Calculate water charge and taxes based on billing slab.
Calculate meter reading charge for water connection
Generate demand
Scheduler for generating the demand(for non metered connection)
Deploy the latest version of ws-service and ws-calculator
Add water-persist.yml & water-meter.yml file in config folder in git and add that path in persister . (The file path is to be added in environment yaml file in param called persist-yml-path )
Criteria :
connection type
building type
calculation attribute
property usage type
The combination of the above can be used to define the billing slab. Billing Slab is defined in MDMS under ws-services-calculation folder with the WCBillingSlab. The following is the sample slab.
If all criteria will match for that water connection this slab will use for calculation.
For application one-time fee, the estimation will return all the related tax head based on criteria. For estimation, all configuration is present in ws-services-calculation.
All the above master configuration is used for estimation.
Following are the exemptions and taxes that are calculated:
Form fee
Scrutiny fee
Meter charge (For metered connection)
Other charges
Road cutting charges
One time fee
Security charges
Tax and cess
Water charge is based on billing slab, for water application charge will be based on slab and tax based on master configuration.
Interest
Below is a sample of master data JSON for interest :
Penalty
Below is a sample of master data JSON for penalty :
Round Off
If the fraction is greater than equal to 0.5 the number is round up else it’s round down. eg: 100.4 will be rounded to 100 while 100.6 will be rounded to 101.
Actions
Role Action Mapping
Once water is sent to the calculator, its tax estimates are calculated. Using these tax head estimates demand details are created. For every tax head, the estimated demand generates function will create a corresponding demand detail.
Whenever _calculate API is called demand is first searched based on the connection no or application no and the demand from and to period. If demand already exists the same demand is updated else new demand is generated with consumer code as connection no or application no and demand from and to a period equal to financial year start and end period.
In the case of an update, if the tax head estimates change, the difference in amount for that tax head is added as new demand detail. For example, if the initial demand has one demand detail with WATER_CHARGE equal to 120
After updating if the WATER_CHARGE increases to 150 we add one more demand detail to account for the increased amount. The demand detail will be updated to:
RoundOff is bill based i.e every time bill is generated round off is adjusted so that the payable amount is the whole number. Individual WS_ROUNDOFF in demand detail can be greater than 0.5 but the sum of all WS_ROUNDOFF will always be less than 0.5.
Description :
For generating the demand for non metered connection we have a feature for generating the demand in batch. The scheduler is responsible for generating the demand based on the tenant.
The scheduler can be hit by scheduler API or we can schedule cron job or we can put config to kubectl which will hit scheduler based on config.
After the scheduler been hit we will search the list of the tenant (city) present in the database.
After getting the tenants we will pick up tenant one by one and generate the demand for that tenant.
We will load the consumer codes for the tenant and push the calculation criteria to Kafka. Calculation criteria contain minimal information (We are not pushing large data to Kafka), calculation criteria contain consumer code and one boolean variable.
After pushing the data into Kafka we are consuming the records based on the batch configuration. Ex:-> if the batch configuration is 50 so we will consume the 50 calculation criteria at a time.
After consuming the record(Calculation criteria) we will process the batch for generating the demand. If the batch is successful so will log the consumer codes which have been processed.
If some records failed in batch so we will push the batch into dead letter batch topic. From the dead letter batch topic, we will process the batch one by one.
If the record is successful we will log the consumer code, If the record is failed so we will push the data into a dead letter single topic.
Dead letter single topic contains information about failure records in Kafka.
Use cases:
If the same job trigger multiple time what will happen?
If the same job triggers multiple times we will process again as mentioned above but at the demand level we will check the demand based on consumer code and billing period, If demand already exists then we will update the demand otherwise we will create the demand.
Are we maintaining success or failure status anywhere?
Currently, we are maintaining the status of failed records in Kafka.
Configuration :
We need to configure the batch size for Kafka consumer. This configuration is for how much data will be processed at a time.1ws.demand.based.batch.size=10
ws-calculator will be integrated with ws-service. ws-services internally invoke the ws-calculator service to calculate and generate demand for the charges.
WS calculator application is used to calculate the water application one time Fees and meter reading charges based on the different billing slabs that's why the calculation and demand generation logic will be separated out from the WS service. So in future, if calculation logic needs to modify then changes can be carried out for each implementation without modifying the WS service.
Once the water connection is activated for metered-connection, employee can add meter reading details using this API - /ws-calculator/meterConnection/_createwhich in-turn will generate the demand. For the Non-Metered connections, the scheduler APIs need to be called periodically to generate the demand.
For the Metered Connection service, to get the previous meter reading /meterConnection/_search API is used.
To Activate the Water Service application, the user needs to pay the ONE_TIME_FEE for the connection. To calculate the ONE_TIME_FEE /waterCalculator/_estimate API is used.
To generate the demand for metered or non-metered water connection /waterCalculator/_calculate API is used.
User can pay partial / full / advance amount for the Metered or Non-Metered connection bill. In these cases, Billing service would call back /waterCalculator/_updateDemandAPI to update the details of the demand generated.
/waterCalculator/_jobscheduler API is use to generate demand for Non-metered connections. This API can be called periodically.
/waterCalculator/_applyAdhocTax API is used to add Rebate or Penalty on any bill and based on that the bill amount will be adjusted.
(Note: All the API’s are in the same postman collection therefore same link is added in each row)
__
__
Sewerage Calculator Service is one of the major business logic services which is used for calculation of sewerage charge, generating demand, update existing demand, SMS & email notification to the ULB officials on-demand generation and also triggering demands(job scheduler) at some intervals and estimation of sewerage charge(one-time cost) which involves cost like road-cutting charge, form fee, scrutiny fee etc.
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 sewerage service persister configs path added in it
PSQL server is running and a database is created to store sewerage connection / application data
Following services should be up and running:
egov-perister
egov-mdms
sw-services
billing-service
Sewerage calculator services present in municipal services provide multiple functionalities like calculating sewerage charges, generating demands for a particular sewerage connection, updating demands, SMS & email notification to the ULB officials on-demand generation and also triggering demands(job scheduler) at some intervals and estimation of sewerage charge(one-time cost) which involves cost like road-cutting charge, form fee, scrutiny fee etc. The different functionalities provided by sewerage calculator services are:
Sewerage charge calculation
Demand generation(here as its always non-metered demand will be generated based on time period)
Sewerage charge estimation (one-time cost which involves cost like road-cutting charge, form fee, scrutiny fee etc.)
Deploy the latest version of sw-service and sw-calculator
Add sewerage-persist.yml file in config folder in git and add that path in persister . (The file path is to be added in environment yaml file in param called persist-yml-path )
Criteria :
connection type
building type
calculation attribute
property usage type
The combination of the above can be used to define the billing slab. Billing Slab is defined in MDMS under sw-services-calculation folder with the SCBillingSlab. The following is the sample slab.
If all criteria will match for that sewerage connection this slab will use for calculation.
For application one-time fee, the estimation will return all the related tax head based on criteria. For estimation, all configuration is present in sw-services-calculation.
All the above master configuration is used for estimation.
Following are the exemptions and taxes that are calculated:
Form fee
Scrutiny fee
Other charges
Road cutting charges
One time fee
Security charges
Tax and cess
Sewerage charge is based on billing slab, for sewerage application charge will be based on slab and tax based on master configuration.
Interest
Below is a sample of master data JSON for interest :
Penalty
Below is a sample of master data JSON for penalty**:**
Round Off
If the fraction is greater than equal to 0.5 the number is round up else it’s round down. eg: 100.4 will be rounded to 100 while 100.6 will be rounded to 101.
Role Action Mapping
Once sewerage is sent to the calculator, its tax estimates are calculated. Using the tax head estimates demand details are created. For every tax head, the estimated demand generates function will create a corresponding demand detail.
Whenever _calculate API is called demand is first searched based on the connection no or application no and the demand from and to period. If demand already exists the same demand is updated else new demand is generated with consumer code as connection no or application no and demand from and to a period equal to financial year start and end period.
In the case of an update, if the tax head estimates change, the difference in amount for that tax head is added as new demand detail. For example, if the initial demand has one demand detail with SEWERAGE_CHARGE equal to 120
After updating if the SEWERAGE_CHARGE increases to 150 we add one more demand detail to account for the increased amount. The demand detail will be updated to:
RoundOff is bill based i.e every time bill is generated round off is adjusted so that the payable amount is the whole number. Individual SW_ROUNDOFF in demand detail can be greater than 0.5 but the sum of all SW_ROUNDOFF will always be less than 0.5.
For generating the demand for non metered connection we have a feature for generating the demand in batch. The scheduler is responsible for generating the demand based on the tenant.
The scheduler can be hit by scheduler API or we can schedule cron job or we can put config to kubectl which will hit scheduler based on config.
After the scheduler been hit we will search the list of the tenant (city) present in the database.
After getting the tenants we will pick up tenant one by one and generate the demand for that tenant.
We will load the consumer codes for the tenant and push the calculation criteria to Kafka. Calculation criteria contain minimal information (We are not pushing large data to Kafka), calculation criteria contain consumer code and one boolean variable.
After pushing the data into Kafka we are consuming the records based on the batch configuration. Ex:-> if the batch configuration is 50 so we will consume the 50 calculation criteria at a time.
After consuming the record(Calculation criteria) we will process the batch for generating the demand. If the batch is successful so will log the consumer codes which have been processed.
If some records failed in batch so we will push the batch into dead letter batch topic. From the dead letter batch topic, we will process the batch one by one.
If the record is successful we will log the consumer code, If the record is failed so we will push the data into a dead letter single topic.
Dead letter single topic contains information about failure records in Kafka.
Use cases
If the same job trigger multiple time what will happen?
If the same job triggers multiple times we will process again as mentioned above but at the demand level we will check the demand based on consumer code and billing period, If demand already exists then we will update the demand otherwise we will create the demand.
Are we maintaining success or failure status anywhere?
Currently, we are maintaining the status of failed records in Kafka.
Configuration
We need to configure the batch size for Kafka consumer. This configuration is for how much data will be processed at a time.1sw.demand.based.batch.size=10
sw-calculator will be integrated with sw-service. sw-services internally invoke the sw-calculator service to calculate and generate demand for the charges.
SW calculator application is used to calculate the sewerage application one time Fees and connection charges based on the different billing slabs that's why the calculation and demand generation logic will be separated out from SW service. So in future, if calculation logic needs to modify then changes can be carried out for each implementation without modifying the SW service.
To Activate the Sewerage Service application, the user needs to pay the ONE_TIME_FEE for the connection. To calculate the ONE_TIME_FEE sw-calculator/sewerageCalculator/_estimate API is use.
To generate the demand for non-metered sewerage connection /sw-calculator/sewerageCalculator/_calculate API is use.
User can pay partial / full / advance amount for the Non-Metered connection bill. In these cases, Billing service would call back /sw-calculator/sewerageCalculator/_updateDemandAPI to update the details of the demand generated.
/sw-calculator/sewerageCalculator/_jobscheduler API is use to generate demand for Non-metered connections. This API can be called periodically.
/sw-calculator/sewerageCalculator/_applyAdhocTax API is used to add Rebate or Penalty on any bill and based on that the bill amount will be adjusted.
(Note: All the API’s are in the same postman collection therefore same link is added in each row)
__
__
This is one of the major application of the egov stack which helps municipal and citizens to handle sewerage services like creating sewerage connection, searching sewerage connection, sewerage connection, also creating property if it doesn't exist and creating and updating workflow were depending on different roles of the logged-in user he/she can perform various actions like editing or perform document verification and many more specified in workflow documentation and SMS & email notification sent to the owner for various actions performed in the workflow.
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 sewerage service persister config path added in it
PSQL server is running and a database is created to store sewerage connection / application data
knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-sms, eGov-email,eGov-user, eGov-localization, eGov-workflow-service will be helpful.
The sewerage service provides multiple functionalities starting from serving as a central repository where one can create sewerage connection, update sewerage connection, search for a particular sewerage connection based on different criteria like mobile number, sewerage connection nos etc. and also creating property if it doesn't exist, creating and updating workflow were depending on different roles of the logged-in user he/she can perform various actions like editing or perform document verification and many more specified in workflow documentation and SMS & email notification sent to the owner for various actions performed in the workflow. The different services provided by the sewerage services are
Creating sewerage connection
Updating sewerage connection
Apply for Property creation.
Searching sewerage connection based on a few criteria mentioned in swagger documentation later
Creating property if it doesn't exist
Creating and updating workflow.
To Do
Table UML Diagram
****
MDMS configuration
master-config.json for sewerage service
Property creation through WNS module https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/PropertyTax/PTWorkflow.json
Persister configuration: https://github.com/egovernments/configs/blob/qa/egov-persister/sewerage-persist.yml
Actions & Role Action Mapping
Actions
Role Action Mapping
Workflow business service config
Create businessService (workflow configuration) using the __/businessservice/_create. Following is the product configuration for sewerage service
Workflow for property creation through Water and Sewerage Module
Indexer config for sewerage-service
The indexer provides the facility for indexing the data to elastic search. https://github.com/egovernments/configs/blob/DEV/egov-indexer/sewerage-service.yml
Setup
Write the configuration for sewerage service. https://github.com/egovernments/configs/blob/DEV/egov-indexer/sewerage-service.yml
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.
Run the egov-indexer app, Since it is a consumer, it starts listening to the configured topics and indexes the data.
Modify connection
After connection activation or legacy connection, we can edit the connection. This process based on a defined workflow. Any action is based on defined roles on the action level. For edit connection, we need to upload some supporting documents and mandatory info.
Workflow config for edit connection
Create businessService (workflow configuration) using the __/businessservice/_create. Following is the product configuration for editing sewerage connection.
1{ 2 "RequestInfo": { 3 "apiId": "Rainmaker", 4 "action": "", 5 "did": 1, 6 "key": "", 7 "msgId": "20170310130900|en_IN", 8 "requesterId": "", 9 "ts": 1513579888683, 10 "ver": ".01", 11 "authToken": "{{Auth_Token}}" 12 }, 13 "BusinessServices": [ 14 { 15 "tenantId": "pb", 16 "businessService": "ModifySWConnection", 17 "business": "sw-services", 18 "businessServiceSla": 259200000, 19 "states": [ 20 { 21 "sla": null, 22 "state": null, 23 "applicationStatus": null, 24 "docUploadRequired": false, 25 "isStartState": true, 26 "isTerminateState": false, 27 "isStateUpdatable": false, 28 "actions": [ 29 { 30 "action": "INITIATE", 31 "nextState": "INITIATED", 32 "roles": [ 33 "SW_CEMP" 34 ] 35 } 36 ] 37 }, 38 { 39 "sla": null, 40 "state": "INITIATED", 41 "applicationStatus": "INITIATED", 42 "docUploadRequired": false, 43 "isStartState": false, 44 "isTerminateState": false, 45 "isStateUpdatable": true, 46 "actions": [ 47 { 48 "action": "SUBMIT_APPLICATION", 49 "nextState": "PENDING_FOR_APPROVAL", 50 "roles": [ 51 "SW_CEMP" 52 ] 53 } 54 ] 55 }, 56 { 57 "sla": 86400000, 58 "state": "PENDING_FOR_APPROVAL", 59 "applicationStatus": "PENDING_FOR_APPROVAL", 60 "docUploadRequired": false, 61 "isStartState": false, 62 "isStateUpdatable": true, 63 "isTerminateState": false, 64 "actions": [ 65 { 66 "action": "APPROVE_CONNECTION", 67 "nextState": "APPROVED", 68 "roles": [ 69 "SW_APPROVER" 70 ] 71 }, 72 { 73 "action": "REJECT", 74 "nextState": "REJECTED", 75 "roles": [ 76 "SW_APPROVER" 77 ] 78 }, 79 { 80 "action": "SEND_BACK", 81 "nextState": "INITIATED", 82 "roles": [ 83 "SW_APPROVER" 84 ] 85 } 86 ] 87 }, 88 { 89 "sla": null, 90 "state": "REJECTED", 91 "applicationStatus": "REJECTED", 92 "isStateUpdatable": false, 93 "docUploadRequired": false, 94 "isStartState": false, 95 "isTerminateState": true 96 }, 97 { 98 "sla": null, 99 "state": "APPROVED", 100 "applicationStatus": "APPROVED", 101 "isStateUpdatable": false, 102 "docUploadRequired": false, 103 "isStartState": false, 104 "isTerminateState": true 105 } 106 ] 107 } 108 ] 109} 110
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 sewerage 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 sewerage connection. For each road which goes under cutting process we have to fill their road type details and road cutting area. Based on this information, application one time fee estimate is calculated.
This sw-service module is use to manage sewerage service connections against a property in the system.
Provide backend support for the different sewerage connection registration process.
Mseva and SMS notifications on application status changes.
Elastic search index for creating visualisations and Dashboards.
Supports workflow which is configurable
To integrate, the host of sw-service module should be overwritten in helm chart.
/sw-services/swc/_create should be added as the create endpoint for creating sewerage application/connection in the system
/sw-services/swc/_search should be added as the search endpoint .This method handles all requests to search existing records depending on different search criteria
/sw-services/swc/_update should be added as the update endpoint. This method is used to update fields in existing records or to update the status of the application based on workflow.
(Note: All the API’s are in the same postman collection therefore same link is added in each row)
__
__
The Sewerage Charges module offers a consolidated platform for managing new and existing sewerage connections. The module eliminates the need for manual processing and streamlines the key sewerage management functions for operational efficiency. DIGIT Water & Sewerage (W&S) module enables automated processing of new connection requests, generating water bills, and facilitating online payment of bills.
DIGIT Sewerage Charges module enables citizens to -
Apply for new sewerage connections.
Upload documents required for processing new connections.
Pay sewerage connection charges and bills using online payment gateway.
Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation.
Download sewerage connection approval letter, payment receipts, and bills online.
DIGIT Sewerage module enables employees at ULB and State level to -
Process applications using customizable workflows.
Configure sewerage charges, interest, and penalty calculation logic.
View custom dashboards for module statistics.
Filter search results using advanced configurable search parameters.
None
None
The penalty is levied on the consumer if the consumer fails to make the payment for the bill raised before a specified due date. The consumer has to make the full payment before the due date to avoid penalty charges. The number of days after which the penalty is applicable should be configurable at the ULB level.
The penalty can be -
Fixed amount; or
Percentage: In case of percentage, it can be levied on either
Entire bill amount; or
Balance pending when partial payments have been made
The data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Enter the applicable value for the Grace Period.
Enter the corresponding Penalty Flat Amount.
Select the relevant parameter for Penalty Based On to specify if the calculation of the penalty is based on the bill amount or the pending balance.
Enter the applicable percentage value for calculating the Penalty amount.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Separate Entity Specific Checklist is not required for this module data.
Sewerage Charges are recurring charges levied for a pre-defined billing period. The billing period is configurable as per the state or ULB requirement. The rate for calculation of sewerage charges can vary widely and is dependent upon various parameters. For instance, they can be dependent either upon plot size slab combined with property usage type or solely dependent upon property usage type. In some cases, sewerage charges can also be levied as a percentage of water charges.
The data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Select the relevant Property Usage Type from the available drop-down list.
Enter the From and To value for property size to specify the range applicable for the selected property.
Enter the Flat Fee applicable for the selected property and Slab.
Enter the applicable Percentage of Water Charges value. The sewerage charges will be calculated as a percentage of the water charges.
Enter the corresponding consumption Rate per unit.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Separate Entity Specific Checklist is not required for this module data.
Technical Doc
DSS has two sides to it. One is the process in which the data is pooled into 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 W&S.
What is analytics?
Analytics: Micro Service which is responsible for building, fetching, aggregating and computing the data on ElasticSearch to a consumable data response. This is later used for visualizations and graphical representations.
Chart API Configuration
Master Dashboard Configuration
Role Dashboard Mappings 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 W&S.
Master dashboard configuration is the main configuration which defines the dashboards to be painted on the screen.
It includes all the visualizations, their groups, the charts which come within them and even their dimensions as what should be their height and width.
Master Dashboard Configuration which was explained earlier contains 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 authorised 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.
common-masters/uiCommonConstants.json
roleaction.json
Action test.json
W&S-DSS consists of multiple graphs which represent the data of W&S. Each graph has its own configuration which will describe the chart and its type.
DSS consists of the following charts in W&S:
Revenue Tab
Overview
Total Cumulative Collection
Top ULB By Performance
Bottom ULB by Performance
W&S Collection by Usage Type
W&S Collection by Channel Type
W&S Key Financial Indicators
W&S Tax Heads
Service Tab
Overview
Total Cumulative Connection
Water Connection By Usage
Sewerage Connections By Usage
Connection By Channel
W&S Connection Ageing
Overview
The overview graph contains multiple data information as below in the selected time period.
Today’s Collection: This represents today’s collection amount for Water and Sewerage Application Fee + Consumption Charges.
Total Collection: This represents the total collection amount for Water and Sewerage Application Fee + Consumption Charges.
Target Collection: This represents the target collection amount for the Water and Sewerage connections.
Target Achievement: This represents the target achieved in percentage. This is calculated by the formula- (Total Collection/Target Collection)*100%
This Graph contains the Water and Sewerage collection amount information on a monthly basis as a cumulative line graph for each water and sewerage 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.
This graph represents the ULBs based on the Target achieved in bar chart representation with the % of target achieved in descending order.
This graph represents the ULBs based on the target achieved in bar chart representation with the % of target achieved in ascending order.
W&S Collection by Usage Type
This graph shows the collection amount based on the usage/property type and this amount will change as per the denomination filter change.
This graph shows the collection amount based on the collection channel type(eg-online, counter, etc) and this amount will change as per the denomination filter change.
This tabular chart representation graph shows multiple W&S information like Target Collection, Total Collection, Total Transactions, Total Connections and Target Achievement (in %). And this table shows the data at the district level and also has the drill-down chart for each district to ulb and from ulb to ward level data for the same.
xtable type allows to the addition of 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 district name will enter into drill-down charts, which will represent that specific District data.
On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.
This tabular chart representation graph shows multiple W&S information like Total Collection, Penalty, Interest and Target Collection. And this table shows the data at the district level and also has the drill-down chart for each district to ulb and from ulb to ward level data for the same.
table type allows to addition of multiple aggregated fields.
On click of any district name will enter into drill-down charts, which will represent that specific District data.
On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.
Overview
The overview graph contains multiple data information as below in the selected time period.
Total Applications: This represents the total number of applications for new, modify, and disconnection requests.
SLA Compliance: This represents the total SLA achieved in percentage.
Total Active Connections: This represents the total active water and sewerage connections.
Water-Metered Connections: This represents the total active metered water connections.
Water-Non Metered Connections: This represents the total active non-metered water connections.
Sewerage Connections: This represents the total active sewerage connections.
Total Cumulative Connections
This Graph contains the Water and Sewerage connections information on a monthly basis as a cumulative line graph for each water and sewerage connection separately.
line - this graph/chart is data representation on date histograms or date groupings.
This graph shows the active Water connections based on the usage/property type.
Sewerage Connections by Usage Type
This graph shows the active Sewerage connections based on the usage/property type.
This graph shows the active water and sewerage connections by channel type(eg-online, counter, etc).
W&S Connection Ageing
This tabular chart representation graph shows W&S applications that have been submitted and have been pending to be worked on. Information like Pending from 0 to 3 days, Pending from 3 to 7 days, Pending from 7 to 15 days, Pending for more than 15 days, and Total Pending Applications is shown in the chart. And this table shows the data at the district level and also has the drill-down chart for each district to ulb and from ulb to ward level data for the same.
xtable type allows the addition of 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 district name will enter into drill-down charts, which will represent that specific District data.
On click of the ULB will navigate to wards under that specific ULB and each ward shows the specific data regarding that ward.
isRoundOff: This property is introduced to round off the decimal values. Ex: if the value is 25.43 by using isRoundOff property in the configuration we will get it as 25. if the value is 22.56 round of value will be 23. This can be used for insights configuration as well for overview graphs.
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 the 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 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. Water and sewerage are W&S.
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 filtered 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 donut
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 values with headers as grouped on and a list of its key, values pairs.
xtable - represents an advanced feature of the table, it has additional capabilities for dynamic adding header values.
valueType: In any case of data, the values which are sent to the 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 the amount from the 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 aggregations of data sources. There might be some cases where we have to do a post-aggregation computation.
For Example, in the case of the top 3 Performing ULBs, the Target and Total Collection are obtained and then the percentage is calculated. In these kinds of cases, the action that has to be performed on the 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 them. In order to fetch the value out of each Aggregation Response, 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.
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Put indexer config file to the config repo under egov-indexer folder. (egovernments/configs )
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
All content on this page by is licensed under a .
Sr. No. | *Penalty based on (Bill amount/Balance pending) | *Grace period (days) | Penalty flat amount (Rs) | Penalty (%) |
---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No. | *Property Usage Type | *Property size slab from (units) | *Property size slab to (units) | *Percentage of water charges (%) | *Flat fee (in Rs) | *Rate |
---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Analytics Configurations: Analytics contains multiple configurations. We need to add the changes related to Water & Sewerage(W&S) in this dashboard analytics. Here is the location: Below is a list of configurations that need to be changed to run W&S successfully.
Postman collection for W&S-dss: ,
Title
Link
/ws-calculator/meterConnection/_create
/ws-calculator/meterConnection/_search
/waterCalculator/_estimate
/waterCalculator/_calculate
/waterCalculator/_updateDemand
/waterCalculator/_jobscheduler
/waterCalculator/_applyAdhocTax
Title
Link
/sw-calculator/sewerageCalculatorr/_estimate
/sw-calculator/sewerageCalculator/_calculate
/sw-calculator/sewerageCalculator/_updateDemand
/sw-calculator/sewerageCalculator/_jobscheduler
/sw-calculator/sewerageCalculator/_applyAdhocTax
Environment Variables
Description
egov.sewarageservice.createconnection
This variable contains the kafka topic name which is used to create new sewerage connection application in the system.
egov.sewarageservice.updateconnection
This variable contains the kafka topic name which is used to update the existing v connection application in the system.
egov.sewerageservice.updatesewerageconnection.workflow.topic
This variable contains the kafka topic name which is used to update the process instance of the sewerage connection application.
egov.idgen.scapid.name
This variable contain the idgen format name for sewerage application
egov.idgen.scapid.format
This variable contain the idgen format for sewerage application ex:- WS/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]
egov.idgen.scid.name
This variable contain the idgen format name for sewerage connection
egov.idgen.scid.format
This variable contain the idgen format for sewerage connection ex:- WS_AP/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]
Title
Link
API Swagger Documentation
Sewerage Calculator Service
Title
Link
/sw-services/swc/_create
/sw-services/swc/_update
/sw-services/swc/_search
1 | Balance Pending | 15 | 40 | 10 |
1 | Grace period | Integer | 2 | Yes | After the bill is generated, certain days are provided to the citizen for making the payment |
2 | Penalty flat amount | Decimal | (3,2) | Yes | If the penalty is not levied on a percentage basis, it is generally a flat fee which is penalty charges amount |
3 | Penalty based on | Text | 64 | Yes | The penalty can be a certain percentage of the bill amount or balance pending if partial payments are made against the bill |
4 | Penalty (%) | Decimal | (3,2) | Yes | The penalty is calculated as a percentage amount based on either Bill amount or Balance pending |
1 | Residential | 1 | 150 | 30 | 200 | 5 |
2 | Residential | 151 | 300 | 40 | 500 | 10 |
Title
Link
API Swagger Contract
Water Service Document
Title
Link
API Swagger Contract
Sewerage Service Document
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Property usage type | Text | 64 | Yes |
2 | Slab (Property size value) | Decimal | (10,2) | Yes | From and to value for property size |
3 | Flat fee | Decimal | (3,2) | Yes | Flat sewerage charges collected based on property usage type |
4 | Percentage of water charges | Decimal | (3,2) | Yes | Percent value |
5 | Rate | Decimal | (3,2) | Yes | Consumption charges per unit corresponding to the usage type |
1 | Make sure that each and every point in this reference list has been taken care of |
This page provides configuration details for W&S master data templates
The Water Charges module offers a consolidated platform for managing new and existing water connections. The module eliminates the need for manual processing and streamlines the key water management functions for operational efficiency. DIGIT Water & Sewerage (W&S) module enables automated processing of new connection requests, generating water bills, and facilitating online payment of bills.
DIGIT Water Charges module enables citizens to -
Apply for new water connections.
Upload documents required for processing new connections.
Pay water connection charges and water bills using an online payment gateway.
Receive SMS alerts on application status, bills generated, payment due date, and payment receipt confirmation.
Download water connection approval letter, payment receipts, and bills online.
DIGIT Water module enables employees at ULB and State level to -
Process applications using customizable workflows.
Configure water charges, interest, and penalty calculation logic.
View custom dashboards for module statistics.
Filter search results using advanced configurable search parameters.
None
None
Interest is levied on the consumer if the consumer fails to make the bill payment before a specified due date. The consumer has to make the full payment before the due date to avoid interest charges. The number of days after which the interest is applicable is configurable at the ULB level. The interest amount is charged to the consumer on a daily basis once the specified grace period is over and till the bill payment is done.
Interest rate: The interest rate on a daily basis can be levied on -
Entire bill amount
Balance pending when partial payments have been made
Data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Enter the applicable Grace Period for calculating interest.
Select the relevant parameter for Interest-Based On to specify if the interest is applied to the bill amount or pending balance.
Enter the applicable percentage value for Interest Rate that will be used to calculate the interest amount.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Separate Entity Specific Checklist is not required for this module data.
Water Charges are levied for metered connections based on consumption. The rate for calculation of water charges varies widely and is dependent upon various parameters. In the DIGIT W&S module, water charges defined are based on actual consumption and property usage type.
The data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Select the property type from the drop-down list available in the Property Usage Type column.
Enter the Slab (water consumed) range details in the From and To Value for water consumed.
Enter the Rate for the specified slab range and property type.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per the expectation. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
A separate Entity Specific Checklist is not required for this module data.
Water pipes are available in different sizes. Pipe size is a common parameter used for calculating water charges. The allotted pipe size for new water connections depends on specific service requirements.
The data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to understand the headers in the template sheet, their data type, size, and definitions.
Reach out to the person who shared the template for further details or to clear your doubts. Identify if the State/ULB has a provision for capturing pipe size for connections.
Enter the Pipe Size details.
Enter the corresponding UOM for the specified Pipe Size.
Go through the checklist to verify the data. Make sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data type, size, and format of data is as per specifications. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
A separate entity-specific checklist is not needed for this module data.
There are two reasons for recording the water source. One is to measure availability vs consumption. And, the other is to monitor the water quality. Each ULB captures this information. Hence, the water source details are configurable at the ULB level. ULBs can configure water source data at two levels - water source and water sub source.
The data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document for more details on data type, size, and definitions.
Contact the person who shared this template with you to discuss and clear your doubts.
Enter the relevant Water Source.
Enter the corresponding Water Sub Source. This will map the water sub source to the specified water source.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist is a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
A separate Entity Specific Checklist is not required for this module data.
The penalty is levied on the consumer in case the consumer fails to make the payment for the bill raised before the specified due date. The consumer has to make the full payment before the due date to avoid penalty charges. The number of days after which the penalty is applicable is configurable at the ULB level. The penalty calculation logic may differ from one state or ULB to another.
The penalty can be -
Fixed amount
Percentage: When it is a percentage, it can be levied on
Entire bill amount
Balance pending when partial payments have been made
The data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Enter an appropriate value for Penalty Based On.
Enter a value for the Grace Period.
Enter the Penalty Flat Amount.
Enter the Penalty value in percent.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Separate Entity Specific Checklist is not required for this module data.
Water Charges are recurring charges levied for a pre-defined billing period. The billing period is configurable as per the state or ULB requirement. The rate for calculation of water charges vary widely and is dependent upon various parameters. Charges for water are dependent upon either plot size slab or No. of taps combined with property usage type. In some cases, they can also be solely dependent upon the property usage type.
The data given in the table is sample data for reference.
Download the data template attached to this page.
Refer to the ‘Data Definition’ section of this document to learn more about the template sheet, data type, size, and definitions.
Please reach out to the person who has shared this template with you to discuss and clear your doubts.
Select the property type from the drop-down list available in the Property Usage Type column.
Enter the Slab (property size value) range details in the From and To Value for property size.
Enter the value for No. of Taps. The water charges will be calculated on the number of taps.
Enter the Rate or the per-unit water consumption charges that will be applicable for the listed parameters.
Verify the data once again by going through the checklist and making sure that each and every point mentioned in the checklist is covered.
The checklist contains a set of activities to be performed once the data is filled into a template to ensure data entry requirements are met. These activities have been divided into 2 groups as given below.
This checklist covers all the activities which are common across the entities.
Separate Entity Specific Checklist is not required for this module data.
Refer to
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | *Interest based on (Bill amount/Balance pending) | *Grace Period (days) | *Interest rate |
---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | *Property Usage Type | *Water consumed value from (units) | *Water consumed value to (units) | *Rate (in Rs/ unit) |
---|---|---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | Pipe Size* | UOM* |
---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | *Water source | *Water sub source |
---|---|---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|---|---|---|---|---|
Sr. No. | Checklist Parameter | Example |
---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Sr. No. | *Penalty based on (Bill amount/Balance pending) | *Grace period (days) | *Penalty flat amount (Rs) | *Penalty (%) |
---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
Sr. No. | Property Usage Type* | Property size value from (units) | Property size value to (units) | No. of taps | Rate |
---|
Sr. No. | Column Name | Data Type | Data Size | Mandatory | Description |
---|
Sr. No. | Checklist Parameter | Example |
---|
All content on this page by is licensed under a .
1
Balance Pending
15
5
1
Grace period
Integer
2
Yes
After the bill is generated, certain days are provided to the citizen for making the payment
2
Interest-based on
Text
64
Yes
Interest can be levied on either bill amount or balance pending if partial payments are made against the bill
3
Interest rate
Decimal
(3,2)
Yes
Time-based Interest percentage
1
Make sure that each and every point in this reference list has been taken care of
1
Residential
1
150
3
2
Residential
151
300
4
1
Property usage type
Alphanumeric
64
Yes
Refer Usage Category Major
2
Water consumed value from
Decimal
(5,3)
Yes
From value for water consumed
3
Water consumed value to
Decimal
(5,3)
Yes
To value for water consumed
4
Rate
Decimal
(3,3)
Yes
Consumption charges per unit corresponding to the usage type
1
Make sure that each and every point in this reference list has been taken care of
1
0.25
Inches
2
0.50
Inches
1
Pipe size
Decimal
(2,2)
Mandatory
Value for Pipe size
2
UOM
Text
256
Mandatory
Unit of measurement for the pipe size value
1
Make sure that each and every point in this reference list has been taken care of
2
UOM should same for all the values provided pipe size in the template
E.g. If it is given as Inches then it should be inches for all.
1
Ground
Well
2
Ground
Hand-pump
1
Water source
Text
64
Yes
Water source major category
2
Water sub source
Text
64
Yes
Water source minor category
1
Make sure that each and every point in this reference list has been taken care of
1 | Balance Pending | 15 | 40 | 10 |
1 | Grace period | Integer | 2 | Yes | After the bill is generated, certain days are provided to the citizen for making the payment |
2 | Penalty flat amount | Decimal | (3,2) | Yes | If the penalty is not levied on a percentage basis, it is generally a flat fee which is penalty charges amount |
3 | Penalty based on | Text | 64 | Yes | The penalty can be a certain percentage of the bill amount or balance pending if partial payments are made against the bill |
4 | Penalty (%) | Decimal | (3,2) | Yes | The penalty is calculated as a percentage amount based on either Bill amount or Balance pending |
1 | Residential | 1 | 150 | 1 | 200 |
2 | Residential | 151 | 200 | 1 | 300 |
1 | Make sure that each and every point in this reference list has been taken care of |
1 | Property usage type | Alphanumeric | 64 | Yes |
2 | Slab (Property size value) | Decimal | (10,2) | Yes | From and to value for property size |
3 | No. of Taps | Integer | 2 | Yes | No. of Taps to be recorded for calculation of water charges |
4 | Rate | Decimal | (3,2) | Yes | Consumption charges per unit corresponding to the usage type |
1 | Make sure that each and every point in this reference list has been taken care of |
Specifies the
PT-Calculator Service is used for creating demands based on property assessments, mutations, and updating demands with the penalty, interest in case of payment delay.
Before you proceed with the documentation, make sure the following pre-requisites are met -
Java 8
Kafka server is up and running
PSQL server is running and a database is created to store property/application data
Following services should be up and running:
MDMS
property-services
billing-service
Calculate property tax, mutation fee based on billing slab.
create and update demand.
Deploy the latest version of property service and pt-calculator
Criteria:
Property Type
Property Subtype
Usage Category Major
Usage Category Minor
Usage Category Subminor
Usage Category Detail
Ownership Category
Sub Ownership Category
Plot Size
Floor Number
Area Type
The combination of the above variables can be used to define a billing slab. The billing slabs are stored in db in the table named “eg_pt_billingslab_v2”. To perform CRUD operations on the billing slabs API’s are provided in the module. Following is a sample create request:
The ‘ALL' keyword can be used if the slab is independent of that particular variable. If ‘fromPlotSize’ or ‘toPlotSize’ values are null they will set to positive infinity and negative infinity, a similar process will be for ‘fromFloor’ and 'toFloor’ values.
The estimation service class loops through all the units and calculates the tax based on the applicable billing slab. The exemptions are calculated using master data in MDMS Service. Each tax or exemption is added to the tax head estimate. Following are the exemptions and taxes that are calculated:
Property Base Tax
Owner Exemption
Unit Exemption
Penalty
Rebate
Interest
Fire Cess
Cancer Cess
From the above charges and exemptions penalty, interest and rebate are time-based. Rebate is given if the payment is done before the rebate deadline date specified in Rebate master data. Similarly, the penalty is charged if payment is not done before the deadline to pay tax. After the deadline to pay tax is passed daily interest is charged according to the rate defined in the master.
Property tax is calculated by adding the tax for each unit calculated using the billing slab for that unit. The formula for calculating tax for the unit is:
In case the unit is commercial and rented the formula is as follows:
ARV stands for Annual rent value.
If the property contains ground units (i.e unit with floor number = 0) then tax is also calculated for the unbuilt area. The formula for calculating the tax on the unbuilt area is as follows:
Below is a sample of master data JSON for interest :
If the given year rate is not defined the service will recursively fall back on the previous year until it finds a defined rate slab. The time for which interest is applicable is calculated by subtracting the epoch value of starting day (At 00:00 AM) from the end of the day (23:59 PM) epoch value of the current date. In the case of partial payment, the interest is calculated for each interval between payments and summed as the applicable amount for interest won’t be constant throughout.
If the fraction is greater than equal to 0.5 the number is round up else it’s round down. eg: 100.4 will be rounded to 100 while 100.6 will be rounded to 101
The following is the format of penalty master data:
If the time during the demand creation date is greater than the penalty starting day, a penalty of x% will be applied. The x% is defined in the rate field. The penalty also provides a fallback for master data i.e if for a particular year entry is not present it will recursively search for the previous year and apply that rate.
Depending on the owner type of user flat amount or percentage of tax amount is given as exemption. In the case of multiple owners, the exemption is calculated for each owner and summed. Following is a sample master data:
Once the property is sent to the calculator its tax estimates are calculated. Using these tax head estimates demand details are created. For every tax head, the estimate-demand function will create a corresponding demand detail.
Whenever _calculate API is called demand is first searched based on the property id and the demand from and to period. If demand already exists the same demand is updated else new demand is generated with consumer code as property and demand from and to a period equal to financial year start and end period. In the case of Reassessment, the demand is always updated for the given year.
In case of update, if the tax head estimates changes, the difference in amount for that tax head is added as new demand detail. For example, if the initial demand has one demand detail with PT_TAX equal to 100
After updating if the PT_TAX increases to 150 we add one more demand detail to account for the increased amount. The demand detail will be updated to:
RoundOff is bill-based i.e every time bill is generated round-off is adjusted so that the payable amount is the whole number. Individual PT_ROUNDOFF in demand detail can be greater than 0.5 but the sum of all PT_ROUNDOFF will always be less than 0.5.
If demand is created and the total tax is supposed 100.40, then a negative round-off amount of -0.40 is added so that the tax becomes 100. If during reassessment the tax changes and becomes 111.70, to round it off estimate will give tax head estimate of +0.3. The demand generation logic will add a new demand detail by taking the difference in the old and new tax amount for that tax head. Therefore a new demand detail of 0.3-(-0.4)=0.7 will be added. There will be now two PT_ROUNDOFF tax heads one with an amount -0.4 and the other with 0.7 making the total round-off amount (-0.4+0.7)= 0.3 which with the tax amount of 111.70 will give a bill amount of 111.70+0.3=112.
PT-calculator should be integrated with property-services which internally invokes the calculator service to calculate and generate demand for the charges.
Carries out the process of creating demand and updating them on a need basis as per the requirement of assessment and mutation.
/_caluclate should be exposed internally for property-services integration.
/_estimate API should be exposed for UI integration, which enables users to view the estimate before proceeding.
/demand/_update API should be configured in billing service for demand update function on bill expiry.
Property-services Property Services
API Collection - https://www.getpostman.com/collections/d7c858f62b53d17c4335
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.