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...
Service configuration details are available on the links below.
This page provides an overview of mCollect functions to all stakeholders. mCollect is an application in which ULB employees can collect any miscellaneous tax or fee from the citizens and citizens can search for the payment receipts to download. mCollect helps ULBs to eliminate the use of manual receipt (G8-receipt) to capture miscellaneous payments at the counter and on the field. It also streamlines the end-of-day collection process in the ULBs by digitising all payment streams.
The platform is available for use in both mediums as web and mobile app. mCollect features can be broadly classified as the following modules: Registration, Login and Creation of User Profile Capture Payment (ULB Employee) Search Receipt (ULB Employee) Search Receipt (Citizen) Dashboards and Reports (ULB Employee) General Features
This module provides enables the following capabilities:
OTP Based Login for Citizen via Web/Mobile App
Credentials (Username & Password) 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
When an employee wants to capture payments made to the ULB by the citizen. He will click on the “New Collection” button and will land on the payment capturing page. The Employee will fill out all the service details and click on “Next” to go to the Payment page. Employees can come back to the details page from the payment page and update all the details too.
On the Payment page, the employee selects the payment instrument, enters the payer details and clicks on the “Generate Receipt” to capture the payment and generate the receipt for the same.
When an employee wants to search for a receipt from a previous payment. He will search based on the given parameters. Search results will give a receipt download link along with other details.
When a citizen wants to search for a receipt from a previous payment. He will search based on the given parameters. Search results will give a receipt download link along with other details.
Administrators want to monitor the collection to drive and plan ULB revenue targets. mCollect offers a receipt register report and a Dashboard to view the data and make data driven decisions.
The Report has the following filters: Collection Channel, Collection Mode, Service Type, Date Range. The Dashboard provides a view like the following screenshot.
Notifications: The system has the capability to send notifications to citizens. The notification is sent to the citizen when a payment is made. The citizen gets a receipt download link in the notification. These notifications can be sent in the language chosen by the ULB through all channels - SMS, WhatsApp, and Email.
Configurable Masters
Business Service Master: To configure the Service Categories and Service Types for which mCollect can capture payments
Tax Head Master: To define the tax heads for each Service Type
Tax Period Master: To define a tax period for each Service Type
This page provides configuration details for MCS master data templates
The mCollect module is designed to facilitate the ULBs process miscellaneous types of payments. Miscellaneous payments may include parking fees, advertising fees, etc. The module objective is to process and record payment collections on account of miscellaneous heads within the ULBs. This makes it easy to track payment receipts and generate reports for administrative purpose.
Capture details of payment collection
Generate and print the collection receipt
Access to dashboard analytics
Generate reports for administration
None
Receipt Register
Cancelled Receipt Register
eChallan system enables employees to generate the challans for Adhoc services so that the payment can be recorded into the system along with service-specific details.
It also enables citizens to make payments online based on challan no.
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 workflow persister config path added in it
PSQL server is running and a database is created to store workflow configuration and data
Allow the employee to capture service details for miscellaneous services and collect payment
Allow the employee to update / cancel challan.
Search, download, and print echallan / bill for miscellaneous service
Generate and view echallan / bill pdf for all miscellaneous and ad-hoc services
Send SMS and an email bill notification to the citizen with a payment link and bill link
MDMS Configuration
Actions
Role Action Mapping
Roles to be available:
Add MDMS configs required for eChallan Service and calculator and restart MDMS service
Deploy the latest version of eChallan Service and calculator
Add eChallan Service persister yaml path in persister configuration and restart persister service
Add Role-Action mapping for API’s
Add pdf configuration file for challan and bill
The eChallan service is used to generate e-challans / bill for all miscellaneous / adhoc services which citizens avail from ULBs.
Can perform service-specific business logic without impacting the other module.
Provides the capability of capturing the unique identifier of the entity for which the challan is generated.
In the future, if we want to expose the application to citizens then it can be done easily.
Workflows or Service-specific workflows can be enabled at the challan service level at any time without changing the design.
Allow an employee to update / cancel challan
To integrate, a host of echallan-services modules should be overwritten in the helm chart.
echallan-services/eChallan/v1/_create should be added as the create endpoint for creating eChallan in the system
echallan-services/eChallan/v1/_search should be added as the search endpoint. This method handles all requests to search existing records depending on different search criteria
echallan-services/eChallan/v1/_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)
e-Challan Calculator service is used to calculate the e-challan amount based on the details present in the e-challan request. This module is designed in such a way that it can be used to serve e-challan for different types of services.
Before you proceed with the configuration, 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 eChallan Calculator Application data.
Following services should be up and running:
egov-mdms
echallan-services
billing-service
e-challan service internally call e-challan-calculator to generate demand.
Based on the tax head and tax amount defined in e-challan request, e-challan calculator service creates the demand.
After Demand creation, it calls the billing service to generate the fees.
MDMS Config
Define the tax period in the below MDMS file for the business service defined in the e-challan service.
Define the tax head in the below MDMS file for the business service defined in the e-challan service.
Define the action and role action mapping for the APIs in the below MDMS files.
Add MDMS configs required for e-Challan Service and calculator and restart MDMS service.
Deploy the latest version of e-Challan Service and calculator.
Add e-Challan Service persister yaml path in persister configuration and restart persister service
Add role-action mapping for APIs.
e-Challan-calculator is integrated with e-Challan-services. The e-Challan-services internally invoke the e-Challan-calculator service to calculate and generate demand for the e-Challan request.
The e-Challan calculator application is used to calculate the e-Challan Fees based on the data mentioned in e-Challan creation. Based on the tax amount mentioned in the e-Challan, demand is created. So because of the e-Challan calculator, the calculation and demand generation logic is separated out from eChallan services. So in future, if calculation logic requires changes, the modifications can be carried out for each implementation without making any changes to the e-Challan services.
e-Challan service application needs to call the eChallan-calculator/v1/_calculate API to calculate and generate the demand for the e-Challan application.
Service Category is a comprehensive list of services existing for the specific State/ULB. Service Category basically defines the miscellaneous revenue collection heads. Example - Rental, Entry Fees, User Charges etc.
Service categories are defined at a global level for different types of revenues. Payment collection and processing for certain services like property tax and trade licenses are done through the individual modules. The mCollect module processes payments for other miscellaneous services.
The Service Category masters list allows States/ULBs to identify the miscellaneous services for which payments and collections can be processed.
| Sr. No. | Service Category Code* | Service Category (In English)* | Service Category (In Local Language)* |
|---|---|---|---|
The data given in the table is sample data.
| Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Definition/ Description |
|---|---|---|---|---|---|
Download the data template attached to this page.
Have it open and go through all the headers and understand the meaning of them by referring 'Data Definition' section.
Make sure all the headers, its data type, field size and its definition/ description is understood properly. In case of any doubt, please reach out to the person who has shared this document with you to discuss the same and clear out the doubts.
Identify all different types of service categories on the basis of ULB’s functions.
Start filling the data starting from serial no. and complete a record at once. repeat this exercise until the entire data is filled into a template.
Verify the data once again by going through the checklist and taking care of each and every point mentioned in the checklist.
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 mCollect module is designed to facilitate the ULBs process miscellaneous types of payments. Miscellaneous payments may include parking fees, advertising fees, rent, challans, etc. The module objective is to process and record payment collections on account of miscellaneous heads within the ULBs. This makes it easy to track payment receipts and generate reports for administrative purposes.
Capture details of payment collection
Generate and print the collection receipt
Access to dashboard analytics
Generate reports for administration
This section contains all docs and information required to understand the MCS module, its key features, functional scope, and configuration details. Click on the links below to learn more about deploying, configuring, customizing, and using the MCS module.
Functional Specifications
Product Brochure
MCS Workflows
MCS Service Configuration
Implementation Handbook
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 MCS 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.
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
| Title | Link |
|---|---|
| Title | Link |
|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
| Title | Link |
|---|
| Title | Link |
|---|
All content on this page by is licensed under a .
| 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.
All content on this page by is licensed under a .
1
OFF00034
Other Fee and Fines
अन्य शुल्क और जुर्माना
2
SAC00456
Service and Administration Charges
सेवा और प्रशासन प्रभार
1
Service Category Code
Alphanumeric
50
Yes
Unique Identifier for “Service Category” and also a reference for the child mapping
2
Service Category (English)
Text
250
Yes
Name of “Service Category” in English. This will help the user select the category name to process the payment collection
3
Service Category (Local Language)
Text
250
Yes
Name of “Service Category” in Local Language. This will help the user select the category name to process the payment collection
1
Make sure that each and every point in this reference list has been taken care of
1
The Service Category should not contain any special characters
Other Fee and Fines : [Allowed]
#Other Fee and Fines! : [Not allowed]
API Swagger Documentation
echallan-services/eChallan/v1/_create
echallan-services/eChallan/v1/_update
echallan-services/eChallan/v1/_search
echallan-services/eChallan/v1/_count
API Swagger Contract |
eChallan Service Document |
echallan-calculator/v1/_calculate |
The Service Subcategory refers to the secondary level of services. For instance, the Sanitation Tax service describes the specific tax collection service existing at the ULB level.
Before creating the Service Subcategory make sure you have created the Service Category list. Map the Service Subcategory to the corresponding Service Category.
| Sr. No. | Service Subcategory Code* | Service Subcategory (In English)* | Service Subcategory (In Local Language)* | Service Category Code* | Service Category |
|---|---|---|---|---|---|
The data given in the table is sample data.
| Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Definition/ Description |
|---|---|---|---|---|---|
Download the data template attached to this page.
Have it open and go through all the headers and understand the meaning of them by referring 'Data Definition' section.
Make sure all the headers, its data type, field size and its definition/ description is understood properly. In case of any doubt, please reach out to the person who has shared this document with you to discuss the same and clear out the doubts.
Identify all different types of service subcategory on the basis of ULB’s functions.
Start filling the data starting from serial no. and complete a record at once. repeat this exercise until the entire data is filled into a template.
Verify the data once again by going through the checklist and taking care of each and every point mentioned in the checklist.
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.
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, it is just a configuration away from getting the newly introduced scenario involved in this flow of the process.
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. Which shall be later used for visualizations and graphical representations.
Analytics Configurations: Analytics contains multiple configurations. we need to add the changes related to mCollect in this dashboard analytics.
Here is the location : configs/egov-dss-dashboards/dashboard-analytics at qa · egovernments/configs
Below is a list of configurations that need to be changed to run W&S successfully.
Chart API Configuration
Master Dashboard Configuration
Role Dashboard Mappings Configuration
Chart API Configuration
Each visualization has its own properties. Each visualization comes from different data sources (Sometimes it is a combination of different data sources).
In order to configure each visualization and its properties, we have a Chart API Configuration Document.
In this, the visualization code, which happens to be the key, will have its properties configured as a part of the configuration and are easily changeable.
Here is the sample ChartApiConfiguration.json data for the mCollect.
Click here for the complete configuration
The master dashboard configuration is the main configuration which defines the Dashboards to be painted on screen. It includes all the visualizations, their groups, the charts which comes within them and even their dimensions as what should be their height and width.
Click here for the complete configuration
The master dashboard configuration explained earlier holds 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 a 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.
Click here for the complete configuration
common-masters/uiCommonConstants.json
Click here for the complete configuration
roleaction.json
Click here for the complete configuration
Action test.json
Click here for complete configurations
mCollect-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 mCollect:
Overview
Total Cumulative Collection
Receipts by Payment Mode
Collection By Payment Mode
Challan Count by Status
Receipts Count By Status
Collection By Status
Top Categories Collections
Monthly Collections
Collection Report
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 mCollect
Total Collection: This represents the total collection amount for mCollect
Total Challans: This represents the total number of challans created.
Total Receipts: This represents the total number of receipts.
Total Categories: Number of categories against which miscellaneous collections have been made.
Total Cumulative Collection: This Graph contains the mCollect collection amount information on a monthly base as a cumulative line graph. This will change as per the denomination amount filter selection.
line - this graph/chart is data representation on date histograms or date groupings.
Receipts by Payment Mode: This graph represents the number of receipts according to the payment mode used.
Collection by Payment Mode: This graph represents the total collection according to the payment mode used.
Challan Count By Status: This graph shows the total number of challans according to status
Receipts Count by Status: This graph shows the total number of receipts according to status
Collection by Status: This graph shows the total collection according to status
Top Categories Collection: This graph shows the category-wise collection for all the categories in descending order.
Monthly Collections: This shows the monthly break-up of total collections and the total number of receipts.
Collection Report: This tabular chart representation graph shows multiple mCollect information like Total Challans, Total Collection and the total number of receipts. This table also shows the data at the district level and the drill-down chart for each district to ULB and from ULBs 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.
Clicking on any district name drills down charts to provide the data specific to the listed District.
Clicking on the ULB navigates to the wards for the specified ULB and displays the ward-specific data.
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.
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.
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 donuts
line - this graph/chart is data representation on date histograms or date groupings
perform - this chart represents groping data 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 the capabilities for dynamically adding header values.
valueType: In any instance of data, the values which are sent for plotting, 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.
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 Responses, the name of the aggregation in the query will be an easy bet. These aggregation paths will have the names of Aggregation in them.
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.
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, which is followed by the legacyindexer 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
mCollect/echallan-services reindexing steps
Configure the eChallan indexer with the configKey as LEGACYINDEX with the new topic name in the respective indexer yaml
Connect to playground pod.
Delete the kafka connector if already exists with the kafka connection, using below command through playground pod.
Run the 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 follwing below command through playground pod
Alias firenoc-services-enriched as water-services through kibana server.
NOW your echallan-services index is updated with the eChallan/mCollect data.
To provide users with the bill details and the options to cancel the bill.
The screen development file is available in the egov-abg-dev folder within the below link:
FetchBill API returns the Bill Object which contains all the details about the bill including Billing Period, Due Amount, Due Date, and information about the Tax, Cess, Rebate, and Penalty applied to this bill.
Provide employees with the option to Cancel a Receipt for a specific receipt number.
Route -
The search page displays the receipts. Click on the specific receipt number navigates the user to view the receipt details.
The initial MDMS call is made on page load. CancelReceiptReason MDMS is used to display multiple reasons for cancelling.
Action modal - This appears with the click of Cancel Receipt. The cancel receipt action is shown only for the following state of receipt.
Receipt?.paymentStatus !== "CANCELLED" && Receipt?.paymentStatus !== "DEPOSITED" && (Receipt?.instrumentStatus == "APPROVED" || Receipt?.instrumentStatus == "REMITTED"
Data fetch, load and render
Once the Receipt is searched using collection-services/payments/{selectedbusinessService}/_search API, the user can cancel the receipt using /collection-services/payments/{selectedbusinessService}/_workflow API
UI details for eChallan feature in mCollect module
This page offers a detailed insight into the user interface features, screens, and navigation available for the eChallan service in the mCollect module. Browse through this document to find the e-Challan service details, MDMS and localization details.
Objective
Generate e-challans / bills for all miscellaneous / Adhoc services which citizens avail from ULBs
The ability for ULBs to Notify citizens about outstanding payments - Online and offline
Enable Digital payments for citizens - QR code, payment link in notifications, etc.
Employees can Create Challan, by selecting the service category, and entering all consumer information and tax head details.
Selecting City is disabled as UC Employee of City A should be able to access/create only City A-related challans.
Based on the response, Service Type and Service category Dropdowns are Loaded. For eg: Refer to the response object
Based on that "businessService": "WaterCharges.Metered"
Based on the MDMS response TaxHeadMaster are formed by the selected service type dropdown.
Filter the initial Taxhead master with the selected service type with service attribute in each Taxheads.
createChallan method is used to create challan.
/echallan-services/eChallan/v1/_create API is used to create a challan.
Users will be able to see the Challan Acknowledgement once the Challan is created successfully,
Actions available:
Proceed to Payment
Download/print Challan
Navigate back to the Home page
Challan’s can be downloaded through this API egov-pdf/download/UC/mcollect-challan?challanNo=
rainmaker-uc
API Used
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_create
egov-pdf/download/UC/mcollect-challan
This document provides details about the edit challan feature in the mCollect module. Challans are created using create challan option explained in the page.
The edit challan workflow enables users to make any correction in the challan or even cancel created challans.
Use the search tool to find the relevant challan and edit it. The Search and Pay Challan page provides information on how to use the search tool.
Click on the search result to navigate to the view challan screen. The service details are .
Here we use echallan-services/eChallan/v1/_search API to get the Challan Information andbilling-service/bill/v2/_searchto the tax head breakup information. Download/Print using egov-pdf/download/UC/mcollect-challan API.
Actions
Update challan to edit
Cancel challan
To cancel challan, click on cancel and enter the reason for cancellation. This action calls the echallan-services/eChallan/v1/_update API to cancel.
Update challan can be used to edit only Tax head information. Any other information that is freezed, can be changed accordingly to support the requirement.
Once you click on update challan echallan-services/eChallan/v1/_update? API will be called and the challan will be updated accordingly.
rainmaker-uc
API Used
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_update
egov-pdf/download/UC/mcollect-challan
echallan-services/eChallan/v1/_search
billing-service/bill/v2/_search
This page offers the UI details for the search and pays challan feature. Once a challan is created, in order to pay the challan or update the challan, we have to find the relevant challan.
A citizen can only search for the challan, download the challan, and pay for the challan.
In order to make any payment for challans, both Citizen and Employee roles, use the Bill genie screens to get the bill and can proceed with payment.
To enable the service category to search we have to configure billGineiURL in MDMS as follow.
Once billGineiURL is configured for a service, we get an option in bill genie to search for it.
Once the challan is created to Update or cancel challan we use Challan Search.
rainmaker-uc
API Used
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_search
| 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.
The details of the Bill are fetched by calling BillingService fetchBill API and the is used in the query param.
NextStep - On clicking on the next step, the screen navigates to the cancel bill screen. The user must select the option that best states the reason for bill cancellation. More details for the cancel bill screen is available on this page -
The Next Step button file is available in the file path below:
| API | Action ID | Roles |
|---|
View receipt details are available here
Acknowledgement screen It gets shown once the cancel receipt is clicked. File details -
| API | Roles | Action ID |
|---|
Click here to find the .
The service Category is "WaterCharges" and the service Type is "Metered"
The conversion of business Service utils is setServiceCategory method present in ``
Other Validations and Create challan can be referred to in
| API | Roles | Action ID |
|---|
| Related Title | Documentation |
|---|
All content on this page by is licensed under a .
| API | Roles | Action ID |
|---|
| Related Title | Documentation |
|---|
All content on this page by is licensed under a .
Click here to find the and the .
| API | Roles | Action ID |
|---|
| Related Title | Documentation |
|---|
All content on this page by is licensed under a .
1
SANT0045
Sanitation Tax
स्वच्छता कर
TAX00147
Taxes
2
PEF0478
Parks Entry Fee
पार्क प्रवेश शुल्क
EFEE0785
Entry Fee
1
Service Subcategory Code
Alphanumeric
50
Yes
Unique Identifier for “Service Subcategory”.
2
Service Subcategory (English)
Text
250
Yes
Name of “Service Subcategory” in English. This will help the user to select the Subcategory name for processing the payment collection
3
Service Subcategory (Local Language)
Text
250
Yes
Name of “Service Subcategory” in Local Language. This will help the user to select the Subcategory name for processing the payment collection
4
Service Category Code
Alphanumeric
50
Yes
Unique Identifier for “Service Category”
5
Service Category
Text
250
No
The listed Service Subcategory is mapped to the appropriate Service Category
1
Make sure that each and every point in this reference list has been taken care of
1
The Service Category & Subcategory Name should not contain any special characters
Other Fee and Fines : [Allowed]
#Other Fee and Fines! : [Not allowed]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 954 |
| UC_EMP | 2112 |
| UC_EMP | 2115 |
egov-mdms-service/v1/_search | 954 |
echallan-services/eChallan/v1/_update | UC_EMP | 2117 |
egov-pdf/download/UC/mcollect-challan | UC_EMP | 2115 |
echallan-services/eChallan/v1/_search | UC_EMP | 2114 |
billing-service/bill/v2/_search | 1861 |
| 954 |
| UC_EMP | 2114 |
MCollect Search Challan |
MCollect Pay Challan |
MCollect Edit / Update Challan |
MCollect Create Challan |
MCollect Search Challan |
MCollect Pay Challan |
MCollect Create Challan |
MCollect Pay Challan |
MCollect Edit / Update Challan |
Provide employees with the option to search receipts specific to a module, download receipts, check the current status and cancel selected receipts.
Once the user logins with the CR_PT role, the system displays the Receipts module card along with the Total Receipts count.
Clicking on the Search Receipts redirects users to the Inbox/search receipt screen.
Inbox File details https://github.com/egovernments/digit-ui-internals/blob/main/packages/modules/receipts/src/pages/ReceiptInbox.js
MDMS Configs used in this inbox screen ReceiptStatus show the required status in the inbox similarly uiCommonPay fetches the service categories.
The Search and Cancel Receipts option is available only for enabled services. This is configured in uiCommonPay config by setting true the cancelReceipt.
Table Structure
Uses the same table component similar to other modules.
Once the data is fetched using collection-services/payments/{selectedbusinessService}/_search API is used to search and get the required receipt details.
The Same API collection-services/payments/{selectedbusinessService}/_search with a flag isCountRequest to get the required count of total receipts.
On the search results page, users can click on the receipt number to cancel any receipt. The details of this are available in the following document - View Receipt and Cancel
Localisation Modules used
rainmaker-common rainmaker-receipts
To enable multiple business services -
MDMS needs to be updated ascancelReceipt : truefor that specific business service.
Role Actions, update the payment search and workflow API for the new USER Role.
Function logic should be updated to support multiple services. getDefaultReceiptService = () => { return RECEIPTS_DEFAULT_SERVICE;} https://github.com/egovernments/digit-ui-internals/blob/main/packages/modules/receipts/src/utils/index.js
Only the CR_PT role is allowed to use this module.
Frontend Repo
Once the user logs in with WS_CEMP or SW_CEMP roles the BillGenie tree option is available on the left panel of the screen.
Clicking on the BillGenie displays two options as seen in the screenshot below.
Click on the Bill Cancellation option. This routes the user to the search bill screen.
Objective: This option allows employees to search for active bills, download bills, or cancel bills.
For instance, a bill can be cancelled if the tax head information is entered wrong in a bill.
Route - mSeva
Initial MDMS call is made on page load
Note: The search, cancel bill and service category options are available only for enabled services. This is configured in uiCommonPay config by marking the followingcancelBill path as true.
Example:
Table Structure
MUIDataTable is used to implement the table component.
Every column entry is treated as an object.
Any customizations at column level are done through the customBodyRender hook available with the option property of the columns.
Once the data is fetched using egov-searcher/bill-genie/billswithaddranduser/_get API, the returned data is formatted and dispatched to redux.
As seen in the above screenshot, the data is assigned to a specific path inside props.
The table component now fetches the data from its props as shown below.
To cancel bills, employees have to click on the Cancel Bill option. The system navigates to the Bill Details page that displays the bill amount and other details. The bill can be cancelled from this page.
For bill details refer to the document here - Bill Details.
egov-mdms-service/v1/_search,
egov-searcher/bill-genie/billswithaddranduser/_get
Provide employees with the option to search challans, download receipts, check the current status, cancel challans, update challans and collect payment.
Once the user login with UC_EMP Role, then the User will get the mCollect module card with the Total Challan Count.
The clicking of Search Challan navigates to the Inbox/search challan screen.
Route - mSeva
Inbox File link -
Clicking on the Collect button routes users to the common-pay screen with the URL.
example: “https://qa.digit.org/digit-ui/employee/payment/collect/{selectedbusinessService}/{selectedChallanNumber}/tenantId={tenantId}?workflow=mcollect”
This screen is common for all modules.
On Click on download receipt, able to download the receipt of the respective challan number using pdf service API egov-pdf/download/PAYMENT/consolidatedreceipt.
On search results we can click on the challan number to update/cancel any challan, it is explained in the following documentation - Update / Cancel Challan
MDMS Configs used in this inbox screen - applicationStatus to show all required statuses in the inbox, similarly uiCommonPay to get service categories.
Table Structure
Uses the same table component similar to other modules.
Once the data is fetched using echallan-services/eChallan/v1/_search API is being used to search and get data, after that using consumer codes, need to call fetch Bill API billing-service/bill/v2/_fetchbill to get bills for respective challan for showing status, amount and date etc.
The count APIechallan-services/eChallan/v1/_count to get the count of total challans.
rainmaker-uc
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_create
egov-pdf/download/UC/mcollect-challan
echallan-services/eChallan/v1/_count
To provide users with the option to select cancel reasons and the options to cancel the bill.
The screen development files are available in the egov-abg-dev folder within the below-mentioned link.
The reasons for bill cancellation options are fetched from the MDMS service.
PREVIOUS STEP: Clicking on the Previous Step option redirects users to the bill details screen.
Clicking on the cancel bill option triggers the cancel bill API (billing-service/bill/v2/_cancelbill ). Once the API call is successful it routes to the acknowledgement screen.
The Next Step button file is available in the below-mentioned file path.
Acknowledgement Screen
For localisation, the “rainmaker-ws” and “rainmaker-abg” modules are re-used. In case they are any new keys, these are added under “rainmaker-abg”.
Learn how to search, download and print your payment receipts
The citizen pays the fees for miscellaneous services through the CEs or FEs. Once the payment transaction is complete the citizen can access the payment receipts online.
Citizens can
Search receipts
Download receipts
Print receipts
Citizens can search for payment receipts and download or print these online. To search for payment receipts navigate to the mCollect option in the sidebar main menu. Click on Search Challan.
Enter the relevant search parameter. The system enables you to search using payment Receipt No. or Service Category, or payee Mobile No. Click on the Search button.
The system will display the relevant search results in the panel below. Click on the relevant record to view the payment receipt.
The system will generate a pdf format of the payment receipt. Click on the download icon on the pdf page to download the receipt.
Click on the Print icon on the pdf page to print the receipt.
Click on the Reset button to renew your search with different parameters.
A complete guide to using mCollect module
The mCollect module is designed to facilitate the ULBs process miscellaneous types of payments. Miscellaneous payments may include parking fees, advertising fees, rent, challans, etc. The module objective is to process and record payment collections on account of miscellaneous heads within the ULBs. This makes it easy to track payment receipts and generate reports for administrative purposes.
The MCS module enables ULB employees to -
Capture payment details
Generate and print payment collection receipts
Access dashboard analytics
Generate reports for administration
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 MCS module for the defined roles. Click on the relevant role below to learn more about how to use the MCS system.
This section illustrates the steps for different employee user roles at the ULB level
The counter employees or field employees collect and process the miscellaneous payments on behalf of the citizens.
The CE or FE role can -
Collect payment
Search payment receipts
Print receipts
Download payment receipts
CE can process and collect payments for miscellaneous services through the DIGIT web portal or the DIGIT mobile app. To process a new payment navigate to the Universal Collections option in the sidebar main menu.
Click on the New Collection button on the screen. This will open a new collection form page.
Enter the Mobile No. and the Consumer Name of the payee.
Select the applicable Service Category.
The system will prompt the input of Tax amount, CGST, SGST, Field Fee, or any other details depending on the selected Service Category.
Enter the From Date and To Date to identify the applicable payment period. **Enter any additional information in the Comments** field.
Click on the Next button to move to the payment section. The Payment Collection Details page displays the fee details and captures the payment form. The Fee Details panel displays the fee breakup and Total Amount details.
The Capture Payment panel displays the available payment methods. Click on the preferred payment tab. The available payment tabs are Cash, Cheque, and Credit/Debit Card.
Enter the Paid By and the Payee Name details.
Enter the Payer Mobile No.
Enter the Cheque No., Cheque Date, IFSC, Bank Name, and Bank Branch details in case of payment by cheque. Enter your credit card or debit card Last 4 digits, Transaction No., and Re-enter Transaction No. details if you have selected the Credit/Debit Card payment option.
Enter the Gen/G8 Receipt No. issued at the payment counter in case payments are made offline. Enter Gen/G8 Receipt Issue Date mentioned on the receipt.
Click on the Generate Receipt button once the payment is collected or processed. The system will display the payment success acknowledgement message.
Click on the Download button to download/view the receipt. Click on the Print button to print the receipt.
To search for payment receipts navigate to the Universal Collections page in the sidebar main menu.
Enter the relevant search parameter. The system enables you to search using payment Receipt No. or Service Category, or payee Mobile No. Click on the Search button.
The system will display the relevant search results in the panel below. Click on the relevant record to view the payment receipt. The system will generate a pdf format of the payment receipt.
Click on the download icon on the pdf page to download the receipt. Click on the Print icon on the pdf page to print the receipt.
Click on the Reset button to renew your search with different parameters.
Provide employees with the option to create Challan, by selecting the service category, and entering all consumer information and tax head details.
Created hooks for MDMS in mCollect, by using hooks will get the response by passing on the details in the method.
Based on the response, Service Type and Service category Dropdowns are Loaded. For eg: Refer to the response object
Based on that "businessService": "WaterCharges.Metered"
The service Category will be "WaterCharges"
The service Type will be "Metered"
Based on the MDMS response TaxHeadMaster are formed by the selected service type dropdown. Filter the initial Taxhead master with the selected service type with service the attributes in each Taxheads.
createChallan the method is used to create challan.
/echallan-services/eChallan/v1/_create API is used to create a challan.
Once Challan is created successfully, you will be able to see the Challan Acknowledgement.
Actions available:
Print Challan
Go to home
Proceed to Payment
Print Challan: Click on Print Challan, Challan will be downloaded using egov-pdf/download/UC/mcollect-challan API.
Go to home: Click on Go TO Home routes users to the home screen.
Proceed To Payment: Clicking on this routes users to the common pay screen and it is common for all modules also refer to Update / Cancel Challan.
rainmaker-uc
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_update
egov-pdf/download/UC/mcollect-challan
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search we need to pass the businessService (collection-services/payments/{businessService}/_search ).
collection-services/payments/_create
billing-service/bill/v2/_fetchbill
pdf-service/v1/_create
Challans are created using create Challan, it is explained in Challan Creation
Provide Employee to update / Cancel / Pay Challan against a Challan number.
Route - mSeva
After searching for a Challan with a click on the Challan number it navigates to viewing the Challan details. The view Challan details is mentioned over digit-ui-internals/EmployeeChallan.js at main · egovernments/digit-ui-internals
Action modal - This comes up on the click of cancel Challan.
Click on yes, the challan will be cancelled and users will be routed to the acknowledgement screen.
Clicking on the Update Challan option updates and routes users to the acknowledgement screen.
The common pay screen is visible once the user clicks on the Pay Challan/Proceed button to payment from the acknowledgement screen.
This pay screen is common for all the modules.
Clicking on the Collect Payment button payment allows users to collect and route to the acknowledgement screen it is common for all modules.
Click on Print Receipt, qa.digit.org/collection-services/payments/{challanBusinessService}/_search (we need to configure bussinessServices to the respective roles in the MDMS like below ) API will get the payment response, by using that response again we need to call pdf-service/v1/_create API.
Data fetch, load and render
Once the Challan is searched using echallan-services/eChallan/v1/_search API, then we can search for bill details using billing-service/bill/v2/_search for the tax head breakup information.
For Updating/Cancelling the Challan, we can use the API /echallan-services/eChallan/v1/_update.
download/print Challan using egov-pdf/download/UC/mcollect-challan API.
rainmaker-uc
egov-mdms-service/v1/_search
echallan-services/eChallan/v1/_update
egov-pdf/download/UC/mcollect-challan
echallan-services/eChallan/v1/_search
billing-service/bill/v2/_search
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search we need to pass the businessService (collection-services/payments/{businessService}/_search ).
collection-services/payments/_create
billing-service/bill/v2/_fetchbill
pdf-service/v1/_create
Service Subcategory is mapped to relevant GL code to help capture the accounting-related parameters for each service subcategory. The same is used to pass the accounting vouchers into the accounting and finance system.
| Sr.No | Service Subcategory Code* | Service Subcategory (English)* | Service Subcategory (Local Language)* | GLCODE* | ULB CODE | DEPT CODE | FUND Code |
|---|---|---|---|---|---|---|---|
The data given in the table above is sample data.
| Sr. No. | Column Name | Data Type | Data Size | Is Mandatory? | Definition/ Description |
|---|---|---|---|---|---|
Download the data template attached to this page.
Have it open and go through all the headers and understand the meaning of them by referring 'Data Definition' section.
Make sure all the headers, its data type, field size and its definition/ description is understood properly. In case of any doubt, please reach out to the person who has shared this document with you to discuss the same and clear out the doubts.
Identify all different types of service subcategory GL code on the basis of ULB’s functions.
Start filling the data starting from serial no. and complete a record at once. repeat this exercise until the entire data is filled into a template.
Verify the data once again by going through the checklist and taking care of each and every point mentioned in the checklist.
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. There is no entity-specific checklist activity applicable.
Route - mSeva
| API | Roles | Action ID |
|---|---|---|
Initial page - frontend/billSearch.js at master · egovernments/frontend
Form rendering details available in frontend/billSearchCard.js at master · egovernments/frontend
Table rendering details available in frontend/searchResults.js at master · egovernments/frontend
The Bill Search API and formatting data is available in frontend/function.js at master · egovernments/frontend
| API | Roles | Action ID |
|---|---|---|
| API | Roles | Action ID |
|---|---|---|
| Related Title | Documentation |
|---|---|
| API | Action ID | Roles |
|---|---|---|
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.
Digit.MDMSService.getPaymentRules(tenantId, "[?(@.type=='Adhoc')]"); which is present in the below file: digit-ui-internals/CreateChallan.js at main · egovernments/digit-ui-internals
Other Validations and Create challan can be referred in digit-ui-internals/CreateChallan.js at main · egovernments/digit-ui-internals
File Path: digit-ui-internals/EmployeeChallanAcknowledgement.js at main · egovernments/digit-ui-internals
| API | Roles | Action ID |
|---|---|---|
| Related Title | Documenation |
|---|---|
File path of acknowledgement screen: digit-ui-internals/EmployeeChallanAcknowledgement.js at main · egovernments/digit-ui-internals
Update Challan screen, This comes up on the click of update Challan (mSeva ).
File Path: digit-ui-internals/EmployeeChallanAcknowledgement.js at main · egovernments/digit-ui-internals
| API | Roles | Action ID |
|---|---|---|
| Related Title | Documentation |
|---|---|
| Sr. No | Checklist Parameter | Example |
|---|---|---|
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
egov-mdms-service/v1/_search
CR_PT
954
collection-services/payments/PT/_search
CR_PT
2029
egov-mdms-service/v1/_search
954
egov-searcher/bill-genie/billswithaddranduser/_get
SUPERUSER , EMPLOYEE
1804
egov-mdms-service/v1/_search
954
echallan-services/eChallan/v1/_create
UC_EMP
2112
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
echallan-services/eChallan/v1/_count
UC_EMP
2192
MCollect Create Challan
MCollect Edit / Update Challan
billing-service/bill/v2/_cancelbill
1936
SUPERUSER, SW_CEMP, WS_CEMP
egov-mdms-service/v1/_search
954
User Role
Scope of Action
Role Description
Citizen
Search Receipts
Download Receipts
Print Receipts
The citizen pays the applicable fees for miscellaneous services through the CEs or FEs
Counter Employee (CE)
Process New Collection
Search Receipts
Download Receipts
Print Receipts
Counter employees collect miscellaneous payments from the citizens online
Field Employee (FE)
Process New Collection
Search Receipts
Download Receipts
Print Receipts
Field employees also collect miscellaneous payments from the citizens on the field
egov-mdms-service/v1/_search
954
/echallan-services/eChallan/v1/_create
UC_EMP
2112
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search
UC_EMP
2138
collection-services/payments/_create
UC_EMP
1862
pdf-service/v1/_create
UC_EMP
1834
billing-service/bill/v2/_fetchbill
EMPLOYEE
1862
MCollect Search
MCollect Update/Cancel Challan
egov-mdms-service/v1/_search
954
echallan-services/eChallan/v1/_update
UC_EMP
2117
egov-pdf/download/UC/mcollect-challan
UC_EMP
2115
echallan-services/eChallan/v1/_search
UC_EMP
2114
billing-service/bill/v2/_search
UC_EMP
1861
billing-service/bill/v2/_fetchbill
UC_EMP
collection-services/payments/ADVT.Gas_Balloon_Advertisement/_search
UC_EMP
2138
collection-services/payments/_create
UC_EMP
1862
pdf-service/v1/_create
UC_EMP
1834
MCollect Create Challan
MCollect Search Challan
1
PEF0478
Parks Entry Fee
पार्क प्रवेश शुल्क
1404007
1001
DEPT_1
01
2
SANT0045
Sanitation Tax
स्वच्छता कर
1405010
1002
DEPT_2
01
1
Service Category
Text
250
Yes
The type of category which is to be mapped with the relevant service subcategory. Click here for Service category reference
2
Service Subcategory (English)
Text
250
Yes
Name of “Service Sub-category” in English. This will help the user to select the Subcategory name while doing the collection. Click here for Service Subcategory reference
3
Service Subcategory (local Language)
Text
250
Yes
Name of “Service Sub-category” in Local Language. This will help the user to select the Subcategory name while doing the collection
4
GLCODE
Alphanumeric
50
Yes
General Ledger Code (GL Code) is a string of alphanumeric characters assigned to each Service. Click here for the General Ledger Code Reference
5
ULB CODE
Alphanumeric
50
No
The CODE which is specified and assigned to each ULB. It refers to the department
6
DEPT CODE
Alphanumeric
50
No
The Master Department Code linked to the“Service Category” at the State Level. The Department Code can be ascertained from the ULB Departments master. Click here to learn more about ULB Departments
7
FUND Code
Text
250
No
The type of fund allocated/associated with the respective service subcategory. Click here for Fund reference
1
Make sure that each and every point in this reference list has been taken care of
