Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  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 :

  • please refer to the swagger YAML, GOTO: https://editor.swagger.io/  and click on file -> import URL Then add the raw URL of the API doc in the popup.  please go to the docs folder in water services for YAML.

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.

...

  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 :

  • please refer to the swagger YAML, GOTO: https://editor.swagger.io/  and click on file -> import URL Then add the raw URL of the API doc in the popup.  please go to the docs folder in water calculation services for YAML.

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

...

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.

...

For the API information please refer the swagger yaml, GOTO : https://editor.swagger.io/  and click on file -> import url Then add the raw url of the API doc in the pop up. 

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

...

  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 :

  • please refer to the swagger YAML, GOTO: https://editor.swagger.io/  and click on file -> import URL Then add the raw URL of the API doc in the popup.  please go to the docs folder in water services for YAML.

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:

...