> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/mgramseva/introducing-mgramseva/platform/technical-user-docs/backend-services/mgramseva-e-challan-service.md). # mGramSeva e-Challan Service ## 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. ## 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 * Allow employees to update/cancel challan. | **Environment Variables** | **Description** | | -------------------------------------- | ------------------------------------------------------------------------------ | | `egov.user.event.notification.enabled` | This variable is to check the event Notification enabled or not. | | `egov.challan.default.limit` | This variable is to get the default limit value | | `egov.challan.max.limit` | This variable to check the max limit value. | | `create.ws.workflow.name` | This variable will give the business service name while creating the workflow. | | `notification.sms.enabled` | This variable is to check the SMS notifications are enabled or not. | | `egov.localization.statelevel` | This variable is used to check the localizations are state level or not. | | `egov.pending.collection.link` | variable for collection list screen link for notifications | | `egov.monthly.summary.link` | variable for monthly summary screen link for notifications | | `egov.new.Expenditure.link` | variable for new expenditure screen link | | `egov.mark.paid.Expenditure.link` | variable for paid expenditure screen link | | `egov.bilk.demand.failed.link` | variable for mnaul bulk demand generation screen link | | `egov.today.collection.link` | variable for today’s collection screen link | ## Interaction Diagram ![](https://3004460086-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQx3WcyfCEvIVnLyuvkbo%2Fuploads%2FrDIsB33i0JhtlyCjZW4P%2Fimage.png?alt=media\&token=dfe326e5-10fe-4572-b15f-f14fdfade554) ### Configuration Details ***MDMS Configuration***\ \ Actions & Role Action Mapping **Actions** ``` [ { "id": {{PLACEHOLDER1}}, "name": "Expense Create", "url": "/echallan-services/eChallan/v1/_create", "parentModule": "", "displayName": "EChallan Create", "orderNumber": 0, "enabled": false, "serviceCode": "echallan-services", "code": "null", "path": "" }, { "id": {{PLACEHOLDER2}}, "name": "Expense Search", "url": "/echallan-services/eChallan/v1/_search", "parentModule": "", "displayName": "EChallan Create", "orderNumber": 0, "enabled": false, "serviceCode": "echallan-services", "code": "null", "path": "" }, { "id": {{PLACEHOLDER3}}, "name": "Expense Update", "url": "/echallan-services/eChallan/v1/_update", "parentModule": "", "displayName": "EChallan Create", "orderNumber": 0, "enabled": false, "serviceCode": "echallan-services", "code": "null", "path": "" }, { "id": {{PLACEHOLDER4}}, "name": "Vendor Create", "url": "/vedor/v1/_create", "parentModule": "", "displayName": "Vendor Create", "orderNumber": 0, "enabled": false, "serviceCode": "vendor", "code": "null", "path": "" }, { "id": {{PLACEHOLDER5}}, "name": "Vendor Search", "url": "/vendor/v1/_search", "parentModule": "", "displayName": "Vendor Create", "orderNumber": 0, "enabled": false, "serviceCode": "vendor", "code": "null", "path": "" }, { "id": 2007, "name": "Update Password", "url": "/user/password/_update", "parentModule": "", "displayName": "Password Update", "orderNumber": 4, "enabled": false, "serviceCode": "ADMIN", "code": "null", "path": "" }, ] ``` **Role Action Mapping** ``` [ { "rolecode": "EXPENSE_PROCESSING", "actionid": {{PLACEHOLDER1}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "EXPENSE_PROCESSING", "actionid": {{PLACEHOLDER2}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "DASHBOARD_VIEWER", "actionid": {{PLACEHOLDER2}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "GP_ADMIN", "actionid": {{PLACEHOLDER2}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "EXPENSE_PROCESSING", "actionid": {{PLACEHOLDER3}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "SUPERUSER", "actionid": {{PLACEHOLDER4}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "EXPENSE_PROCESSING", "actionid": {{PLACEHOLDER4}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "EXPENSE_PROCESSING", "actionid": {{PLACEHOLDER5}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "SUPERUSER", "actionid": {{PLACEHOLDER5}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "SUPERUSER", "actionid": {{PLACEHOLDER6}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "GP_ADMIN", "actionid": {{PLACEHOLDER6}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "COLLECTION_OPERATOR", "actionid": {{PLACEHOLDER6}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "BULK_DEMAND_PROCESSING", "actionid": {{PLACEHOLDER6}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "EXPENSE_PROCESSING", "actionid": {{PLACEHOLDER6}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "DASHBOARD_VIEWER", "actionid": {{PLACEHOLDER6}}, "actioncode": "", "tenantId": "pb" }, { "rolecode": "PROFILE_UPDATE", "actionid": {{PLACEHOLDER6}}, "actioncode": "", "tenantId": "pb" }, ] ``` Roles available ``` { "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 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 / 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 1. To integrate, the 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 application based on workflow. 5. `/echallan-services/eChallan/v1/_expenseDashboard` Is added in echallan-service to show the data of expenses in metrix format. 6. `/echallan-services/eChallan/v1/_chalanCollectionData` it is added to get the main monthly dashboard data for the expense. ## Reference Docs ### Doc Links | **Title** | **Link** | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | API Swagger Documentation | [Swagger Documentation](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/e-Challan-v1.0.0.yaml#!/) | ### API List | | **Link** | | ---------------------------------------------------- | ------------------------------------------------------------- | | *echallan-services/eChallan/v1/\_create* | | | *echallan-services/eChallan/v1/\_update* | | | *echallan-services/eChallan/v1/\_search* | | | echallan-services/eChallan/v1/\_chalanCollectionData | | | echallan-services/eChallan/v1/\_chalanCollectionData | | *(Note: All the API’s are in the same postman collection therefore the same link is added in each row)* > [![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)*​*](http://creativecommons.org/licenses/by/4.0/)*All content on this page by* [*eGov Foundation*](https://egov.org.in/) *is licensed under a* [*Creative Commons Attribution 4.0 International License*](http://creativecommons.org/licenses/by/4.0/)*.* --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.digit.org/mgramseva/introducing-mgramseva/platform/technical-user-docs/backend-services/mgramseva-e-challan-service.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.