Water & Sewerage Services v1.0

Owned by Rangabashyam Krishnamachari (Unlicensed)
Last updated: Jun 05, 2020 by Karthikeyan Rajendran (Unlicensed)
6 min read

Water Services

This is the egov application, which helps and gives flexibility to municipal and citizen to handle the water service like create water connection, search water connection, update water connection , creating property if not exists , 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:

  • Knowledge of Java/J2EE(preferably Java 8 version)

  • Knowledge of Spring Boot and spring-boot microservices.

  • Knowledge of Git or any version control system.

  • Knowledge of RESTful Web services.

  • Knowledge of the Lombok library will helpful.

  • knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-sms, eGov-email,eGov-user, eGov-localization, eGov-workflow-service will be helpful.

 

Functionality:

Water Service provides multiple functionalities like creating water connection, updating water connection, search water connection on given criteria, creating property if not exists,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 functionalities provided by water services as follows -

  1. Creating water connections.

  2. Searching for water connections.

  3. Updating water connections.

  4. Creating a property registry for a water connection (If not exists).

  5. Creating and updating workflow.

Setup and usage:

The Application is present among the municipal services group of applications available in the eGov-services git repository.  The spring boot application needs the 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 :

Application.properties File Information:

kafka topics persister configs for eGov persister

  • egov.waterservice.createwaterconnection = save-ws-connection

  • egov.waterservice.updatewaterconnection=update-ws-connection

  • egov.waterservice.updatewaterconnection.workflow.topic=update-ws-workflow

URLs for the external API references:

egov.idgen.wcapid.name=waterservice.application.id
egov.idgen.wcapid.format=WS_AP/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]

 

Water Search Parameter Criteria:

  • connectionNumber, mobileNumber, ids (connection key),applicationNumber,fromDate,toDate,tenantId,applicationStatus.

Water Calculator Service

This is the Egov application, which is used for creating meter reading, searching meter reading, updating existing meter reading, calculation of water charge, demand generation, SMS & email notification to ULB officials on-demand generation and estimation of water charge(one-time cost) which involves cost like road-cutting charge , form fee , scrutiny fee etc.

The setup of the Application is as follows

Requirements:

  • Knowledge of Java/J2EE(preferably Java 8 version)

  • Knowledge of Spring Boot and spring-boot microservices.

  • Knowledge of Git or any version control system.

  • Knowledge of RESTful Web services.

  • Knowledge of the Lombok library will helpful.

  • knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-sms, eGov-email,eGov-user, eGov-localization , eGov-workflow-service will be helpful.

 

Functionality:

Water Calculator Service provides multiple functionalities like creating meter reading, updating meter reading, searching meter readings on given criteria, calculation of water charge, demand generation and estimation of water charge(one-time cost) which involves cost like road-cutting charge , form fee , scrutiny fee etc. The different functionalities provided by water calculator service as follows -

  1. Creating meter readings(For metered connection).

  2. Updating meter readings.

  3. Searching for meter readings.

  4. Water charge calculation.

  5. demand generation(For metered connection, demand will be generated after meter reading capture. For non-metered connection demand will be generated based on time period.).

  6. Water charge estimation(one-time cost which involves cost like road-cutting charge , form fee , scrutiny fee etc.)

Setup and usage:

The Application is present among the municipal services group of applications available in the eGov-services git repository.  The spring boot application needs the 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 :

Application.properties File Information:

kafka topics persister configs for eGov persister

  • egov.meterservice.createmeterconnection=save-ws-meter

  • kafka.topics.notification.sms=egov.core.notification.sms

  • notification.sms.enabled=true

  • notification.email.enabled=false

  • kafka.topics.notification.mail.name=egov.core.notification.email

  • egov.watercalculatorservice.createdemand=ws-generate-demand

  • notification.sms.link=citizen/egov-common/pay?consumerCode=$consumerCode&tenantId=$tenantId&businessService=WS

URLs for the external API references:

Meter Reading Search Parameter Criteria:

  • connectionNos

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

  1. Creating sewerage connection

  2. Updating sewerage connection

  3. Searching sewerage connection based on few criterias mentioned in swagger documentation later

  4. Creating property if it doesnt exist

  5. Creating and updating workflow. 

SETUP AND USAGE:

The Application is present among the municpal 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 :

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

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] 

Sewerage Search Parameters config (filter for search based on fields by user Type)

  • connectionNumber, mobileNumber, ids (connection key),tenantId,applicationNumber,fromDate,toDate,applicationStatus.

Sewerage calculator services:

This is one of the major business logic services which is used for calculation of sewerage charge, generating demand, update existing demand , SMS & email notification to the ULB officials on demand generation and also triggering demands(job scheduler) at some intervals and estimation of water charge(one-time cost) which involves cost like road-cutting charge , form fee , scrutiny fee etc.

Requirements:

  • Knowledge of Java/J2EE(preferably Java 8 version)

  • Knowledge of Spring Boot and spring-boot microservices.

  • Knowledge of Git or any version control system.

  • Knowledge of RESTful Web services.

  • Knowledge of the Lombok library will helpful.

  • knowledge of eGov-mdms service, eGov-persister, eGov-idgen, eGov-sms, eGov-email,eGov-user, eGov-localization, eGov-workflow-service will be helpful.

 

Functionality:

Sewerage calculator services present in municipal services provides multiple functionalities like calculating sewerage charges, generating demands for a particular sewerage connection , updating demands, SMS & email notification to the ULB officials on demand generation and also triggering demands(job scheduler) at some intervals and estimation of water charge(one-time cost) which involves cost like road-cutting charge , form fee , scrutiny fee etc. The different functionalities provided by sewerage calculator services are:

  1. Sewerage charge calculation

  2. Demand generation(here as its always non-metered demand will be generated based on time period)

  3. Sewerage charge estimation(one-time cost which involves cost like road-cutting charge , form fee , scrutiny fee etc.)

Setup and usage:

The Application is present among the municipal services group of applications available in the eGov-services git repository.  The spring boot application needs the 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 :

Application.properties File Information:

kafka topics persister configs for eGov persister(for notification)

  • kafka.topics.notification.sms=egov.core.notification.sms

  • notification.sms.enabled=true

  • kafka.topics.notification.mail=notification.mail

  • notification.mail.enabled=true

  • kafka.topics.notification.mail.name=egov.core.notification.email

  • egov.seweragecalculatorservice.createdemand=sw-generate-demand

  • notification.sms.link=citizen/egov-common/pay?consumerCode=$consumerCode&tenantId=$tenantId&businessService=SW

URLs for the external API references: