Sewerage Services:
This is one of the major application of the egov stack which helps municipal and citizens to handle sewerage services like creating sewerage connection , searching sewerage connection, sewerage connection , also creating property if it doesnt exist and creating and updating workflow where depending on different roles of the logged-in user he/she can perform various actions like editing or perform document verification and many more specified in workflow documentation and SMS & email notification sent to owner for various actions performed in workflow.
The setup of the Application is as follows
Requirements:
Prior Knowledge of Java/J2EE(Java 8 version preferrable).
Prior Knowledge of Spring Boot.
Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.
Prior knowledge of Git.
Prior knowledge of eGov-mdms service, eGov-persister, eGov-user, eGov-location, eGov-localization, eGov-idgen, eGov-workflow-service will be helpful.
FUNCTIONALITY:
The sewerage service provides multiple functionality starting from serving as a central repository where one can create sewerage connection, update sewerage connection, search for a particular sewerage connection based on different criterias like mobile number, sewerage connection nos etc. and also creating property if it doesnt exist ,creating and updating workflow where depending on different roles of the logged-in user he/she can perform various actions like editing or perform document verification and many more specified in workflow documentation and SMS & email notification sent to owner for various actions performed in workflow.The different services provided by the sewerage services are
Creating sewerage connection
Updating sewerage connection
Searching sewerage connection based on few criterias mentioned in swagger documentation later
Creating property if it doesnt exist
Creating and updating workflow.
SETUP AND USAGE:
The Application is present among the municipal group of applications available in the eGov-services git repository. The spring boot application needs lombok* extension added in your IDE to load it. Once the application is up and running API requests can be posted to the url and ids can be generated.
in case of intellij the plugin can be installed directly, for eclipse the lombok jar location has to be added in eclipse.ini file in this format javaagent:lombok.jar
API Information :
Please refer Swagger API for YAML file details. Link -https://app.swaggerhub.com/apis/egov-foundation/Water-Sewerage-1.0/1.0.0.
The variables in the Application.properties to be updated are as follows
kafka topics persister configs for eGov persister
egov.sewarageservice.createconnection=save-sw-connection
egov.sewarageservice.updateconnection=update-sw-connection
egov.sewerageservice.updatesewerageconnection.workflow.topic=update-sw-workflow
URLs for the external API references
eGvo mdms :-> egov.mdms.host = https://egov-micro-dev.egovernments.org
eGov -idGen :-> egov.idgen.host = https://egov-micro-dev.egovernments.org/
localization service :-> egov.localization.host = https://egov-micro-dev.egovernments.org
workflow-service:-> egov.workflow.host = https://egov-micro-dev.egovernments.org/
Url-Shortner
egov.url.shortner.host=http://egov-url-shortening.egov:8080idGen Id formats :->
egov.idgen.scid.name=sewerageservice.connection.id
egov.idgen.scid.format=SW/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]
egov.idgen.scapid.name=sewerageservice.application.id
egov.idgen.scapid.format=SW_AP/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]
Configuration:
Mdms configuration:
https://github.com/egovernments/egov-mdms-data/tree/master/data
sw-services-calculation
master-config.json for sewerage service
"sw-services-calculation": {
"Interest": {
"masterName": "Interest",
"isStateLevel": true,
"uniqueKeys": [
"$.fromFY"
]
},
"Rebate": {
"masterName": "Rebate",
"isStateLevel": true,
"uniqueKeys": [
"$.fromFY"
]
},
"Penalty": {
"masterName": "Penalty",
"isStateLevel": true,
"uniqueKeys": [
"$.fromFY"
]
},
"SCBillingSlab": {
"masterName": "SCBillingSlab",
"isStateLevel": true,
"uniqueKeys": []
},
"billingPeriod": {
"masterName": "billingPeriod",
"isStateLevel": true,
"uniqueKeys": [
"$.billingCycle"
]
},
"SW_CHARGE": {
"masterName": "SW_CHARGE",
"isStateLevel": true,
"uniqueKeys": []
},
"SW_TIME_PENALTY": {
"masterName": "SW_TIME_PENALTY",
"isStateLevel": true,
"uniqueKeys": []
},
"SW_Round_Off": {
"masterName": "SW_Round_Off",
"isStateLevel": true,
"uniqueKeys": []
},
"PlotSizeSlab": {
"masterName": "PlotSizeSlab",
"isStateLevel": true,
"uniqueKeys": []
},
"PropertyUsageType": {
"masterName": "PropertyUsageType",
"isStateLevel": true,
"uniqueKeys": []
},
"FeeSlab": {
"masterName": "FeeSlab",
"isStateLevel": true,
"uniqueKeys": []
},
"RoadType": {
"masterName": "RoadType",
"isStateLevel": true,
"uniqueKeys": []
},
"CalculationAttribute": {
"masterName": "CalculationAttribute",
"isStateLevel": true,
"uniqueKeys": []
}
}
Persister configuration:
https://github.com/egovernments/configs/blob/master/egov-persister/sewerage-persist.yml
Postman link:
https://www.getpostman.com/collections/27458a8c6249d786317c
Workflow business service config:
{
"BusinessServices": [
{
"tenantId": "pb",
"businessService": "NewSW1",
"business": "sw-services",
"businessServiceSla": 259200000,
"states": [
{
"sla": null,
"state": null,
"applicationStatus": null,
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"action": "INITIATE",
"nextState": "INITIATED",
"roles": [
"CITIZEN",
"SW_CEMP"
]
}
]
},
{
"sla": null,
"state": "INITIATED",
"applicationStatus": "INITIATED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"action": "SUBMIT_APPLICATION",
"nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
"roles": [
"CITIZEN",
"SW_CEMP"
]
}
]
},
{
"sla": null,
"state": "PENDING_FOR_CITIZEN_ACTION",
"applicationStatus": "PENDING_FOR_CITIZEN_ACTION",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"action": "RESUBMIT_APPLICATION",
"nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
"roles": [
"CITIZEN",
"SW_CEMP"
]
}
]
},
{
"sla": null,
"state": "PENDING_FOR_DOCUMENT_VERIFICATION",
"applicationStatus": "PENDING_FOR_DOCUMENT_VERIFICATION",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"action": "VERIFY_AND_FORWARD",
"nextState": "PENDING_FOR_FIELD_INSPECTION",
"roles": [
"SW_DOC_VERIFIER"
]
},
{
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"SW_DOC_VERIFIER"
]
},
{
"action": "SEND_BACK_TO_CITIZEN",
"nextState": "PENDING_FOR_CITIZEN_ACTION",
"roles": [
"SW_DOC_VERIFIER"
]
}
]
},
{
"sla": null,
"state": "REJECTED",
"applicationStatus": "REJECTED",
"isStateUpdatable": false,
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true
},
{
"sla": 86400000,
"state": "PENDING_FOR_FIELD_INSPECTION",
"applicationStatus": "PENDING_FOR_FIELD_INSPECTION",
"docUploadRequired": false,
"isStartState": false,
"isStateUpdatable": true,
"isTerminateState": false,
"actions": [
{
"action": "VERIFY_AND_FORWARD",
"nextState": "PENDING_APPROVAL_FOR_CONNECTION",
"roles": [
"SW_FIELD_INSPECTOR"
]
},
{
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"SW_FIELD_INSPECTOR"
]
},
{
"action": "SEND_BACK_FOR_DOCUMENT_VERIFICATION",
"nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
"roles": [
"SW_FIELD_INSPECTOR"
]
}
]
},
{
"sla": 43200000,
"state": "PENDING_APPROVAL_FOR_CONNECTION",
"applicationStatus": "PENDING_APPROVAL_FOR_CONNECTION",
"docUploadRequired": false,
"isStartState": false,
"isStateUpdatable": true,
"isTerminateState": false,
"actions": [
{
"action": "APPROVE_FOR_CONNECTION",
"nextState": "PENDING_FOR_PAYMENT",
"roles": [
"SW_APPROVER"
]
},
{
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"SW_APPROVER"
]
},
{
"action": "SEND_BACK_FOR_FIELD_INSPECTION",
"nextState": "PENDING_FOR_FIELD_INSPECTION",
"roles": [
"SW_APPROVER"
]
}
]
},
{
"sla": 43200000,
"state": "PENDING_FOR_PAYMENT",
"applicationStatus": "PENDING_FOR_PAYMENT",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"action": "PAY",
"nextState": "PENDING_FOR_CONNECTION_ACTIVATION",
"roles": [
"CITIZEN",
"SW_CEMP"
]
}
]
},
{
"sla": null,
"state": "PENDING_FOR_CONNECTION_ACTIVATION",
"applicationStatus": "PENDING_FOR_CONNECTION_ACTIVATION",
"isStateUpdatable": true,
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"actions": [
{
"action": "ACTIVATE_CONNECTION",
"nextState": "CONNECTION_ACTIVATED",
"roles": [
"SW_CLERK"
]
}
]
},
{
"sla": null,
"state": "CONNECTION_ACTIVATED",
"applicationStatus": "CONNECTION_ACTIVATED",
"isStateUpdatable": false,
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true
}
]
}
]
}
Notifications :
To enable or disable notifcation
notification.sms.enabled=true
egov.user.event.notification.enabled=true
Notification config:
notification.url = https://egov-micro-dev.egovernments.org/
kafka.topics.notification.sms=egov.core.notification.sms
notification.sms.link=citizen/egov-common/pay?consumerCode=$consumerCode&tenantId=$tenantId&businessService=SW
sw.mseva.app.link=https://play.google.com/store/apps/details?id=org.egovernment.mseva.citizen
sw.view.history.link=citizen/wns/search-preview?applicationNumber=$applicationNumber&history=true&tenantId=$tenantId&service=SEWERAGE
sw.connectiondetails.link=citizen/wns/connection-details?connectionNumber=$connectionNumber&tenantId=$tenantId&service=SEWERAGE
sw.application.pay.link=citizen/egov-common/pay?consumerCode=$consumerCode&tenantId=$tenantId&businessService=SW.ONE_TIME_FEE
The Current localization messages for notification :
[
{
"code": "SW_INITIATE_INITIATED_SMS_MESSAGE",
"message": "Dear <Owner Name>, You have successfully submitted your application for a New <Service> Connection. Your Application No. is <Application number>. Click here to download your application <Application download link>. For more information, please log in to <mseva URL> or download <mseva app link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_INITIATE_INITIATED_APP_MESSAGE",
"message": "Dear <Owner Name>, You have successfully submitted your application for a New <Service> Connection. Your Application No. is <Application number> . <Action Button>Download Application</Action Button>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_REJECT_REJECTED_SMS_MESSAGE",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been rejected. For more details, please log in to <mseva URL> or download <mseva app link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_REJECT_REJECTED_APP_MESSAGE",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been rejected. Click here for more details <View History Link>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_EDIT_SMS_MESSAGE",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been edited. For more details, please log in to <mseva URL> or download <mseva app link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_EDIT_IN_APP_MESSAGE",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been edited. Click here for more details <View History Link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_VERIFY_AND_FORWARD_PENDING_FOR_FIELD_INSPECTION_SMS_MESSAGE",
"message": "Dear <Owner Name>, Status of your application <Application number> for a New <Service> Connection has changed to PENDING FOR FIELD INSPECTION from PENDING FOR DOCUMENT VERIFICATION. For more details, please log in to <mseva URL> or download <mseva app link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_VERIFY_AND_FORWARD_PENDING_FOR_FIELD_INSPECTION_APP_MESSAGE",
"message": "Dear <Owner Name>, Status of your application <Application number> for a New <Service> Connection has changed to PENDING FOR FIELD INSPECTION from PENDING FOR DOCUMENT VERIFICATION. To track your application, click on <View History Link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_SEND_BACK_FOR_FIELD_INSPECTION_PENDING_FOR_FIELD_INSPECTION_SMS_MESSAGE",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been sent back. For more details, please log in to <mseva URL> or download <mseva app link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_SEND_BACK_FOR_FIELD_INSPECTION_PENDING_FOR_FIELD_INSPECTION_APP_MESSAGE",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been sent back. Click here for more details <View History Link>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_SEND_BACK_FOR_DOCUMENT_VERIFICATION_PENDING_FOR_DOCUMENT_VERIFICATION_SMS_MESSAG",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been sent back. For more details, please log in to <mseva URL> or download <mseva app link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_SEND_BACK_FOR_DOCUMENT_VERIFICATION_PENDING_FOR_DOCUMENT_VERIFICATION_APP_MESSAGE",
"message": "Dear <Owner Name>, Your Application <Application number> for a New <Service> Connection has been sent back. Click here for more details <View History Link>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SEWERAGE_CONNECTION_BILL_GENERATION_MESSAGE",
"message": "Dear <Owner Name>,Your<Service> Bill for <Billing Period> has been generated. Please pay the amount due: <bill amount> by due date <Due Date>. Following is the link to your bill: <Link to Bill>",
"module": "rainmaker-common",
"locale": "en_IN"
},
{
"code": "SEWERAGE_CONNECTION_BILL_GENERATION_SMS_MESSAGE",
"message": "Dear <Owner Name>, Your <Service> Bill has been generated. Please pay the amount due: <bill amount> by due date <Due Date>. Following is the link to your bill: <Link to Bill>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SEWERAGE_CONNECTION_BILL_GENERATION_APP_MESSAGE",
"message": "Dear <Owner Name>, Your <Service> Bill has been generated. Please pay the amount due: <bill amount> by due date <Due Date>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_APPROVE_FOR_CONNECTION_PENDING_FOR_PAYMENT_SMS_MESSAGE",
"message": "Dear <Owner Name>, Your New <Service> connection against the application <Application number> has been approved. To make payment against your application, please click on <payment link> . Log in to <mseva URL> or download <mseva app link> for more details.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_APPROVE_FOR_CONNECTION_PENDING_FOR_PAYMENT_APP_MESSAGE",
"message": "Dear <Owner Name>, Your New <Service> connection against the application <Application number> has been approved. To make payment against your application, please click on PAY NOW .<Action Button>Download Application</Action Button>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_PAY_PENDING_FOR_CONNECTION_ACTIVATION_SMS_MESSAGE",
"message": "Dear <Owner Name> , Your payment for New <Service> connection against the application <Application number> has been been succesfully recorded. You can download your receipt using this link <receipt download link>. For more details, please log in to <mseva URL> or download <mseva app link>.",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_PAY_PENDING_FOR_CONNECTION_ACTIVATION_APP_MESSAGE",
"message": "Dear <Owner Name> , Your payment for New <Service> connection against the application <Application number> has been been succesfully recorded. You can download the receipt by clicking DOWNLOAD RECEIPT.<Action Button>Download Application</Action Button>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_ACTIVATE_CONNECTION_CONNECTION_ACTIVATED_SMS_MESSAGE",
"message": "Dear <Owner Name>, Your New <Service> connection against the application <Application number> has been activated. To check your connection details, please log in to <mseva URL> or download <mseva app link>",
"module": "rainmaker-ws",
"locale": "en_IN"
},
{
"code": "SW_ACTIVATE_CONNECTION_CONNECTION_ACTIVATED_APP_MESSAGE",
"message": "Dear <Owner Name>, Your New <Service> connection against the application <Application number> has been activated. To check your connection details, click here <connection details page>.",
"module": "rainmaker-ws",
"locale": "en_IN"
}
]
Frontend:
Sewerage Citizen UI Guide:
List of features available in the W&S service for Citizen role.
a)Search Bills & Pay:
Citizen, by using different search criteria to find the particular connection and also he/she can able to pay the water and sewerage bill for the particular connection.
My Connections & Connection Details:
All the consumer numbers are clickable in connections list. citizen can see the all connection details and also able to download.
b) Create new application
citizen can able to create new application on click of “Apply for new connection”
In this page citizen need to fill all relevant details for creating the application this is the first page of application, second page is documents upload, Third page is the summary page which includes all the provided details.
c) View Application
In My Applications, Citizen can see the list of applications he/she have. For every application Citizen can see the above fields. on click of ViewDetails button citizen can see the workflow page,There Citizen can perform the actions like(Edit and Resubmit )the application.
d) Pay
Citizen can also Pay the Due amount by using VIEW DETAILS link based on status (Pending for payment).
e)Past payments
Citizen can see his past payment records like which month he paid how much money and basic details are shown in this.
Sewerage Employee UI Guide:
SEARCH APPLICATION / CONNECTION
Once an Application is created (INITIATED state in Workflow), the application number can be used to search the application. There are several other criteria’s that can be used to search the application.
APPLY FOR NEW WATER AND SEWERAGE CONNECTION
All the application once INITIATED can have can have until CONNECTION ACTIVATION can have multiple actions buttons. An with selected roles can forward the application with a specific action to the next stage or can make corrections to it using EDIT.
A water application has been INITIATED (The First Stage in Workflow)
All the applications that has been created once can be submitted (SUBMIT_APPLICATION state in Workflow), by either searching them in using their application number or employee can continue to the next stages and add all the fields required and they will be able to submit the application. Once an application is submitted, they will be redirected to a screen depicted in the below image.
A water application has been SUBMIT_APPLICATION (The Submit Application in Workflow)
Here they will get an option to Download and Print the application, which they have just submitted. An employee can create both Water and Sewerage application at once.
VIEW APPLICATION & CONNECTION DETAILS
Here an Employee can edit the application, VERIFY AND FORWARD the application to the next stages, REJECT, SEND BACK TO CITIZEN who has applied for this connection. These actions that are seen in the below image, appear only for employees having a specific role which allows the employee to take the below actions.
From the options provided in the above image, if the employee clicks on EDIT, it will be redirected to the apply screen where the employee will find the details of the application when it was last updated. The employee can click other option as well. It can also click on one of these options after editing the application and then it can do whatever that the employee deems right for the application.
Note: The employee will only get these options if it is authorized to take any of such actions provided in the above image.
On successful completion of any of the above processes, the employee will be redirected to the below screen. The messages may change based on the actions clicked. Here the action that I have taken is VERIFY_AND_FORWARD. It can be any of the action provided in the above image.
On successful completion of all the states triggered from the actions taken, the employee will reach to the action as PAY. On click of Pay, the employee will be redirected to the below screen. Here the employee can generate receipt of the amount collected from citizen. Employees will be able to see the PAY option, if they are authorized to Collect Payment from citizen.
Once the payment is collected, the employee will be redirected to the below screen. Here employee can download and print receipt.
Once the connection is activated, the employee will be redirected to the below screen. Here employee can go back to home screen.
Once payment has been accepted and the receipt has been generated, the employee can go to search and search the application based on application number. The employee will find the application in Pending Connection Activation state, similar to what is show in the image below. If the employee is authorized to activate the connection, it can activate the connection.
After the connection has been activated, employee can go to the search and search the connection based on connection number, as shown in the image below.
After getting the search result as in the above image for the activate connection, the employee can see the details of the connection (Water or Sewerage) after clicking on the connection number in the Consumer No. column. The connection details looks like below, where the employee can find all the details related to the connection created.
Employee can also download and print the connection details if required.