{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"It also enables citizens to make the payments online based on challan no.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Pre-requisites","type":"text"}]},{"type":"paragraph","content":[{"text":"Before you proceed with the documentation, make sure the following pre-requisites are met -","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Java 8","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Kafka server is up and running","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"egov-persister service is running and has eChallan persister config path added in it","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PSQL server is running and database is created to store eChallan data","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Key Functionalities","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Allow employee to capture service details for miscellaneous services and collect payment","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Allow employee to update / cancel challan.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Search, download, and print echallan / bill for miscellaneous service","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Generate and view echallan / bill pdf for all miscellaneous and ad-hoc services","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Send SMS and an email bill notification to the citizen with a payment link and bill link","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Interaction Diagram","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"98d6af92-57da-4510-a906-537d4365ec88","collection":"contentId-1531740173","type":"file","height":750}}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"4d28f059-c2e1-41eb-b476-75d719f7f6f8","collection":"contentId-1531740173","type":"file","height":647}}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1200,"id":"88833a06-e62e-4750-a14d-5a12fabea88a","collection":"contentId-1531740173","type":"file","height":489}}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"hardBreak"},{"text":"UML Diagram:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":783,"id":"9f11357d-90ef-4e33-8c23-e9ad1ef30040","collection":"contentId-1531740173","type":"file","height":839}}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration Details","type":"text"}]},{"type":"paragraph","content":[{"text":"Mdms configuration","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":":","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Actions & Role Action Mapping","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"type":"hardBreak"},{"text":"Actions","type":"text"}]},{"type":"codeBlock","content":[{"text":"[\n {\n \"id\": {{PLACEHOLDER1}},\n \"name\": \"Expense Create\",\n \"url\": \"/echallan-services/eChallan/v1/_create\",\n \"parentModule\": \"\",\n \"displayName\": \"EChallan Create\",\n \"orderNumber\": 0,\n \"enabled\": false,\n \"serviceCode\": \"echallan-services\",\n \"code\": \"null\",\n \"path\": \"\"\n },\n {\n \"id\": {{PLACEHOLDER2}},\n \"name\": \"Expense Search\",\n \"url\": \"/echallan-services/eChallan/v1/_search\",\n \"parentModule\": \"\",\n \"displayName\": \"EChallan Create\",\n \"orderNumber\": 0,\n \"enabled\": false,\n \"serviceCode\": \"echallan-services\",\n \"code\": \"null\",\n \"path\": \"\"\n },\n {\n \"id\": {{PLACEHOLDER3}},\n \"name\": \"Expense Update\",\n \"url\": \"/echallan-services/eChallan/v1/_update\",\n \"parentModule\": \"\",\n \"displayName\": \"EChallan Create\",\n \"orderNumber\": 0,\n \"enabled\": false,\n \"serviceCode\": \"echallan-services\",\n \"code\": \"null\",\n \"path\": \"\"\n },\n {\n \"id\": {{PLACEHOLDER4}},\n \"name\": \"Vendor Create\",\n \"url\": \"/vedor/v1/_create\",\n \"parentModule\": \"\",\n \"displayName\": \"Vendor Create\",\n \"orderNumber\": 0,\n \"enabled\": false,\n \"serviceCode\": \"vendor\",\n \"code\": \"null\",\n \"path\": \"\"\n },\n {\n \"id\": {{PLACEHOLDER5}},\n \"name\": \"Vendor Search\",\n \"url\": \"/vendor/v1/_search\",\n \"parentModule\": \"\",\n \"displayName\": \"Vendor Create\",\n \"orderNumber\": 0,\n \"enabled\": false,\n \"serviceCode\": \"vendor\",\n \"code\": \"null\",\n \"path\": \"\"\n },\n {\n \"id\": 2007,\n \"name\": \"Update Password\",\n \"url\": \"/user/password/_update\",\n \"parentModule\": \"\",\n \"displayName\": \"Password Update\",\n \"orderNumber\": 4,\n \"enabled\": false,\n \"serviceCode\": \"ADMIN\",\n \"code\": \"null\",\n \"path\": \"\"\n },\n]\n\n","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"type":"hardBreak"},{"text":"Role Action Mapping","type":"text"},{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"[\n {\n \"rolecode\": \"EXPENSE_PROCESSING\",\n \"actionid\": {{PLACEHOLDER1}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"EXPENSE_PROCESSING\",\n \"actionid\": {{PLACEHOLDER2}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"DASHBOARD_VIEWER\",\n \"actionid\": {{PLACEHOLDER2}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"GP_ADMIN\",\n \"actionid\": {{PLACEHOLDER2}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"EXPENSE_PROCESSING\",\n \"actionid\": {{PLACEHOLDER3}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"SUPERUSER\",\n \"actionid\": {{PLACEHOLDER4}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"EXPENSE_PROCESSING\",\n \"actionid\": {{PLACEHOLDER4}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"EXPENSE_PROCESSING\",\n \"actionid\": {{PLACEHOLDER5}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"SUPERUSER\",\n \"actionid\": {{PLACEHOLDER5}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"SUPERUSER\",\n \"actionid\": {{PLACEHOLDER6}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"GP_ADMIN\",\n \"actionid\": {{PLACEHOLDER6}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"COLLECTION_OPERATOR\",\n \"actionid\": {{PLACEHOLDER6}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"BULK_DEMAND_PROCESSING\",\n \"actionid\": {{PLACEHOLDER6}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"EXPENSE_PROCESSING\",\n \"actionid\": {{PLACEHOLDER6}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"DASHBOARD_VIEWER\",\n \"actionid\": {{PLACEHOLDER6}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n {\n \"rolecode\": \"PROFILE_UPDATE\",\n \"actionid\": {{PLACEHOLDER6}},\n \"actioncode\": \"\",\n \"tenantId\": \"pb\"\n },\n]\n\n","type":"text"}]},{"type":"paragraph"},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Roles to be available:","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"hardBreak"}]},{"type":"codeBlock","content":[{"text":"\n\t\t{\n \"code\": \"GP_ADMIN\",\n \"name\": \"GP Admin\",\n \"description\": \"Who has a access to ws-services\"\n },\n\t\t{\n \"code\": \"COLLECTION_OPERATOR\",\n \"name\": \"Collection Operator\",\n \"description\": \"Who has a access to ws-services,demand, bill and payment\"\n },\n\t\t{\n \"code\": \"BULK_DEMAND_PROCESSING\",\n \"name\": \"Bulk Demand Processing\",\n \"description\": \"Who has a access to bulk demand generation,raise bill, downloa bill and receipts\"\n },\n\t\t{\n \"code\": \"EXPENSE_PROCESSING\",\n \"name\": \"Expense Processing\",\n \"description\": \"Who has a access to create and update expenses\"\n },\n\t\t{\n \"code\": \"DASHBOARD_VIEWER\",\n \"name\": \"Dashbaord Viewer\",\n \"description\": \"Who has a access to dashboard of revenue and expenditure\"\n }","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Localization:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"messages\": [\n {\n \"code\": \"echallan.cancel.sms\",\n \"message\": \"Challan No: for has been cancelled.\",\n \"module\": \"rainmaker-uc\",\n \"locale\": \"en_IN\"\n },\n {\n \"code\": \"echallan.create.sms\",\n \"message\": \"Challan No: for INR generated. Pay @ .\",\n \"module\": \"rainmaker-uc\",\n \"locale\": \"en_IN\"\n },\n {\n \"code\": \"echallan.update.sms\",\n \"message\": \"Challan No: updated for . Amount INR . Pay @ .\",\n \"module\": \"rainmaker-uc\",\n \"locale\": \"en_IN\"\n }\n ]\n}","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Deployment Details","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add mdms configs required for eChallan Service and calculator and restart mdms service.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deploy the latest version of eChallan Service and calculator.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add eChallan Service persister yaml path in persister configuration and restart persister service","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add Role-Action mapping for API’s.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add pdf configuration file for challan and bill.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Integration","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Integration Scope","type":"text"}]},{"type":"paragraph","content":[{"text":"The eChallan service is used to generate","type":"text"},{"text":" e-challans / bill","type":"text","marks":[{"type":"strong"}]},{"text":" for all miscellaneous / adhoc services which citizens avail from ULBs.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Integration Benefits","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Can perform service-specific business logic without impacting the other module.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Provides the capability of capturing the unique identifier of the entity for which the challan is generated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the future, if we want to expose the application to citizen then it can be done easily.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Workflow or Service-specific workflow can be enabled at the challan service level at any time without changing the design.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Allow employee to update / cancel challan","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Steps to Integration","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To integrate, host of echallan-services module should be overwritten in helm chart.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"echallan-services/eChallan/v1/_create","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"should be added as the create endpoint for creating eChallan in the system","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"echallan-services/eChallan/v1/_search","type":"text","marks":[{"type":"code"}]},{"text":" should be added as the search endpoint .This method handles all requests to search existing records depending on different search criteria","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"echallan-services/eChallan/v1/_update","type":"text","marks":[{"type":"code"}]},{"text":" 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.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Reference Docs","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Doc Links","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"23cc9a31-1f82-408e-9f3e-fb95396a960e"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#d9d9d9","rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"Title ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#d9d9d9","rowspan":1,"colwidth":[431.0]},"content":[{"type":"paragraph","content":[{"text":"Link","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[328.0]},"content":[{"type":"paragraph","content":[{"text":"API Swagger Documentation","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[431.0]},"content":[{"type":"paragraph","content":[{"text":"Swagger Documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/e-Challan-v1.0.0.yaml#!/"}}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"API List","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"cd388ded-bed7-420e-a63c-490fb1eec056"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#d9d9d9","rowspan":1,"colwidth":[330.0]},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Title ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"background":"#d9d9d9","rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"Link","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[330.0]},"content":[{"type":"paragraph","content":[{"text":" echallan-services/eChallan/v1/_create","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"https://www.getpostman.com/collections/773565d7b5866f0851e3","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.getpostman.com/collections/773565d7b5866f0851e3"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[330.0]},"content":[{"type":"paragraph","content":[{"text":"echallan-services/eChallan/v1/_update","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"https://www.getpostman.com/collections/773565d7b5866f0851e3","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.getpostman.com/collections/773565d7b5866f0851e3"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[330.0]},"content":[{"type":"paragraph","content":[{"text":"echallan-services/eChallan/v1/_search","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"https://www.getpostman.com/collections/773565d7b5866f0851e3","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.getpostman.com/collections/773565d7b5866f0851e3"}}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[330.0]},"content":[{"type":"paragraph","content":[{"text":"echallan-services/eChallan/v1/_count","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[429.0]},"content":[{"type":"paragraph","content":[{"text":"https://www.getpostman.com/collections/773565d7b5866f0851e3","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.getpostman.com/collections/773565d7b5866f0851e3"}}]}]}]}]}]},{"type":"paragraph","content":[{"text":"(Note: All the API’s are in the same postman collection therefore same link is added in each row)","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph"}],"version":1}

Browser not supported