Overview
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 the payments online based on challan no.
Pre-requisites
Before you proceed with the documentation, make sure the following pre-requisites are met -
Java 8
Kafka server is up and running
egov-persister service is running and has workflow persister config path added in it
PSQL server is running and database is created to store workflow configuration and data
Key Functionalities
Allow employee to capture service details for miscellaneous services and collect payment
Allow 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
Interaction Diagram
Deployment Details
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.
Integration
Integration Scope
The eChallan service is used to generate e-challans / bill for all miscellaneous / adhoc services which citizens avail from ULBs.
Integration Benefits
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 citizen then it can be done easily.
Workflow or Service-specific workflow can be enabled at the challan service level at any time without changing the design.
Allow employee to update / cancel challan
Steps to Integration
To integrate, host of echallan-services module should be overwritten in helm chart.
echallan-services/eChallan/v1/_create
should be added as the create endpoint for creating eChallan in the systemechallan-services/eChallan/v1/_search
should be added as the search endpoint .This method handles all requests to search existing records depending on different search criteriaechallan-services/eChallan/v1/_update
should be added as the update endpoint. This method is used to update fields in existing records or to update status of application based on workflow.
Reference Docs
Doc Links
Title | Link |
API Swagger Documentation |
API List
Title | Link |
echallan-services/eChallan/v1/_create | |
echallan-services/eChallan/v1/_update | |
echallan-services/eChallan/v1/_search | |
echallan-services/eChallan/v1/_count |
(Note: All the API’s are in the same postman collection therefore same link is added in each row)
Add Comment