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.
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 a database is created to store workflow configuration and data
Key Functionalities
Allow employees to capture service details for miscellaneous services and mark as paid
{
"code": "GP_ADMIN",
"name": "GP Admin",
"description": "Who has a access to ws-services"
},
{
"code": "COLLECTION_OPERATOR",
"name": "Collection Operator",
"description": "Who has a access to ws-services,demand, bill and payment"
},
{
"code": "BULK_DEMAND_PROCESSING",
"name": "Bulk Demand Processing",
"description": "Who has a access to bulk demand generation,raise bill, downloa bill and receipts"
},
{
"code": "EXPENSE_PROCESSING",
"name": "Expense Processing",
"description": "Who has a access to create and update expenses"
},
{
"code": "DASHBOARD_VIEWER",
"name": "Dashbaord Viewer",
"description": "Who has a access to dashboard of revenue and expenditure"
}
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 / bills for all miscellaneous / adhoc services .
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 citizens then it can be done easily.
The workflow or Service-specific workflow can be enabled at the challan service level at any time without changing the design.
Allow employees to update/cancel challan
Steps to Integration
To integrate, the 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 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 application based on workflow.
/echallan-services/eChallan/v1/_expenseDashboard Is added in echallan-service to show the data of expenses in metrix format.
/echallan-services/eChallan/v1/_chalanCollectionData it is added to get the main monthly dashboard data for the expense.
Reference Docs
Doc Links
API List
(Note: All the API’s are in the same postman collection therefore the same link is added in each row)