Overview

eChallan Calculator service is used to calculate the echallan amount based on the details present in echallan request. This module is designed in such a way that it can be used to serve echallan for different type of service.

Pre-requisites

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

Key Functionalities

• echallan service internally call echallan-calculator to generate demand.

• Based on the tax head and tax amount defined in echallan request, echallan calculator service creates the demand.

• After Demand creation, it calls the billing service to generate the fees.

Configuration Details

MDMS Config

Define the tax period in the below MDMS file for the business service which is allowed in echallan service.

https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/BillingService/TaxPeriod.json

Define the taxhead in the below MDMS file for the business service which is allowed in echallan service.

https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/BillingService/TaxHeadMaster.json

Define the action and role action mapping for the API’s in the below MDMS files.

https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/ACCESSCONTROL-ACTIONS-TEST/actions-test.json

https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/ACCESSCONTROL-ROLEACTIONS/roleactions.json

Deployment Details

1. Add MDMS configs required for eChallan Service and calculator and restart MDMS service.

2. Deploy the latest version of eChallan Service and calculator.

3. Add eChallan Service persister yaml path in persister configuration and restart persister service

4. Add Role-Action mapping for API’s.

Integration

Integration Scope

echallan-calculator will be integrated with echallan-services. echallan-services internally invoke the echallan-calculator service to calculate and generate demand for the echallan request.

Integration Benefits

eChallan calculator application is used to calculate the eChallan Fees based on the data mentioned in echallan creation. Based on the tax amount mentioned in the echallan, demand is created. So because of eChallan calculator, the calculation and demand generation logic will be separated out from eChallan services. So in future, if calculation logic needs to modify then changes can be carried out for each implementation without modifying the eChallan services.

Steps to Integration

eChallan service application needs to call echallan-calculator/v1/_calculate API to calculate and generate the demand for the eChallan application.

Interaction Diagram

TBD

Reference Docs

Doc Links

API List

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 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 a database is created to store workflow configuration and data

Key Functionalities

• 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

Interaction Diagram

1. Add MDMS configs required for eChallan Service and calculator and restart MDMS service

2. Deploy the latest version of eChallan Service and calculator

3. Add eChallan Service persister yaml path in persister configuration and restart persister service

4. Add Role-Action mapping for API’s

5. 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 an employee to update / cancel challan

Steps to Integration

1. To integrate, host of echallan-services module should be overwritten in helm chart.

2. echallan-services/eChallan/v1/_create should be added as the create endpoint for creating eChallan in the system

3. 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

4. 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.

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)

__

__