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. Apply for Property creation.

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

5. Creating property if it doesnt exist

6. 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://github.com/egovernments/municipal-services/blob/RAIN-2317/docs/water-sewerage-services.yaml

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:8080

• idGen 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:

egov-mdms-data/data at master · egovernments/egov-mdms-data

master-config.json for sewerage service

Property creation through WNS module
egov-mdms-data/data/pb/PropertyTax/PTWorkflow.json at DEV · egovernments/egov-mdms-data

Persister configuration:
configs/egov-persister/sewerage-persist.yml at qa · egovernments/configs

Postman link:

https://www.getpostman.com/collections/e4c39fd6c0ed0a7dfacd

Workflow business service config:

Workflow for property creation through Water and Sewerage Module

Indexer config for sewerage-service:

• The indexer provides the facility for indexing the data to elastic search.

Setup:

1. Write the configuration for sewerage service. The structure of the config file is explained later in the same doc.

2. Provide the absolute path of the checked-in file to DevOps, to add it to the file-read path of egov-indexer. The file will be added to the egov-indexer's environment manifest file for it to be read at the start-up of the application.

3. Put indexer config file to the config repo under egov-indexer folder.(GitHub - egovernments/configs )

4. Run the egov-indexer app, Since it is a consumer, it starts listening to the configured topics and indexes the data.

config Keys:

The indexer uses a config file per module to store all the configurations pertaining to that module. Indexer reads multiple such files at start-up to support indexing for all the configured modules. The water service file contains the following keys:

a. serviceName: Name of the module to which this configuration belongs.

b. summary: Summary of the module.

c. version: The version of the configuration.

d. mappings: List of definitions within the module. Every definition corresponds to one index requirement. Which means, every object received onto the Kafka queue can be used to create multiple indexes, each of these indexes will need configuration, all such configurations belonging to one topic forms one entry in the mappings list. The keys listed henceforth together form one definition and multiple such definitions are part of this mappings key.

i. topic: Topic on which the data is to be received to activate this particular configuration.

ii. configKey: Key to identify to what type of job is this config for. values: INDEX, REINDEX, LEGACYINDEX. INDEX: LiveIndex, REINDEX: Reindex, LEGACYINDEX: LegacyIndex.

iii. indexes: Key to configure multiple index configurations for the data received on the particular topic. Multiple indexes based on different requirement can be created using the same object. This list of such configurations is a part of this key. uses the following keys:

1. name: Index name on the elasticsearch. (Index will be created if it doesn't exist with this name.)

2. type: Document type within that index to which the index json has to go. (Elasticsearch uses the structure of index/type/docId to locate any file within index/type with id = docId)

3. id: Takes comma separated JsonPaths. The JSONPath is applied on the record received on the queue, the values hence obtained are appended and used as id for the record.

4. jsonPath: Key to be used in case of indexing a part of the input JSON and in case of indexing a custom json where the values for custom json are to be fetched from this part of the input.

5. timeStampField: JSONPath of the field in the input which can be used to obtain the timestamp of the input.

6. i) indexMapping: A skeleton/mapping of the JSON that is to be indexed. Note that, this JSON must always contain a key called "Data" at the top-level and the custom mapping begins within this key. This is only a convention to smoothen dashboarding on Kibana when data from multiple indexes have to be fetched for a single dashboard.

    ii) fieldMapping: Contains a list of configurations. Each configuration contains keys to identify the field of the input JSON that has to be mapped to the fields of the index json which is mentioned in the key 'indexMapping' in the config. Has the following keys:

   1. inJsonPath: JSONPath of the field from the input.

   2. outJsonPath: JSONPath of the field of the index json.

   iii) externalUriMapping: Contains a list of configurations. Each configuration contains keys to identify the field of the input JSON that are to be enriched using APIs from the external services. The configuration for those APIs also is a part of this. Uses the following keys:

7. path: URI of the API to be used. (it should be POST/_search API.)

8. queryParam: Configruation of the query params to be used for the API call. It is a comma seperated key-value pair, where key is the parameter name as per the API contract and value is the JSONPath of the field to be equated against this paramter.

9. apiRequest: Request Body of the API. (Since we only use _search APIs, it should be only RequestInfo.)

10. uriResponseMapping: Contains a list of configuration. Each configuration contains two keys: One is a JSONPath to identify the field from response, Second is also a JSONPath to map the response field to a field of the index json mentioned in the key 'indexMapping'.

i) inJsonPath: JSONPath to identify the field from response

ii) outJsonPath: JSONPath to map the response field to a field of the index json

sewerage-service indexer config:

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 :

Table UML Diagram:

Open

Modify connection:

After connection activation or legacy connection, we can edit the connection. This process based on defined workflow. Any action is based on defined roles on the action level. For edit connection, we need to upload some supporting documents and mandatory info.

Workflow config for edit connection:

Notification :

Notification will be sent to the property owners and connection holders based on different application states.

Capturing connection holders :

We can add connection holders to the sewerage connection which will be the owner of the connection. We can fill the connection holders' details or we can just make the property owner to the connection holder.

The connection holder will get notification based on a different state of the application. We are pushing the data of the connection holders in the user service too.

Multiple Road Type Support
We can add road cutting details of multiple roads to the sewerage connection. For each road which goes under cutting process we have to fill their road type details and road cutting area.
Based on this information, application one time fee estimate is calculated.

Sewerage Calculator Service

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 :

• Please refer Swagger API for YAML file details. Link -https://app.swaggerhub.com/apis/egov-foundation/Water-Sewerage-1.0/1.0.0.

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:

• 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/

• user-service :-> egov.user.host = https://egov-micro-dev.egovernments.org/

• Url-Shortner
  egov.url.shortner.host=http://egov-url-shortening.egov:8080

Billing Slabs:

Criteria :

1. connection type

2. building type

3. calculation attribute

4. property usage type

The combination of the above can be used to define the billing slab. Billing Slab is defined in mdms under sw-services-calculation folder with the SCBillingSlab. The following is the sample slab.

If all criteria will match for that sewerage connection this slab will use for calculation.

Estimation:

For application one-time fee, the estimation will return all the related tax head based on criteria. For estimation, all configuration is present in ws-services-calculation.

1. FeeSlab.json

2. PlotSizeSlab.json

3. RoadType.json

All the above master configuration is used for estimation.

Following are the exemptions and taxes that are calculated:

• Form fee

• Scrutiny fee

• Other charges

• Road cutting charges

• One time fee

• Security charges

• Tax and cess

Sewerage Charge and Tax:

Sewerage charge is based on billing slab, for sewerage application charge will be based on slab and tax based on master configuration.

Interest:

Below is a sample of master data JSON for interest :

Penalty:

Below is a sample of master data JSON for penalty :

Round Off:

If the fraction is greater than equal to 0.5 the number is round up else it’s round down. eg: 100.4 will be rounded to 100 while 100.6 will be rounded to 101.

Adding Adhoc penalty or rebate:

The only employee can apply for a penalty or rebate for an existing connection. As an employee, I can update or add the penalty and rebate of a connection. This applied penalty or rebate will be added or updated in existing demand as tax heads. For configuration, we have to add the tax head in TaxHeadMaster.json file.

Demand Generation:

Once sewerage is sent to calculator it’s tax estimates are calculated. Using this tax head estimates demand details are created. For every tax head, estimate demand generates function will create a corresponding demand detail.

Whenever _calculate API is called demand is first searched based on the connection no or application no and the demand from and to period. If demand already exists the same demand is updated else new demand is generated with consumer code as connection no or application no and demand from and to a period equal to financial year start and end period.

In case of the update if the tax head estimates change, the difference in amount for that tax head is added as new demand detail. For example, if the initial demand has one demand detail with SEWERAGE_CHARGE equal to 120

After updating if the SEWERAGE_CHARGE increases to 150 we add one more demand detail to account for the increased amount. The demand detail will be updated to:

RoundOff is bill based i.e every time bill is generated round off is adjusted so that payable amount is the whole number. Individual SW_ROUNDOFF in demand detail can be greater than 0.5 but the sum of all SW_ROUNDOFF will always be less than 0.5.

Frontend:

Configurations:

ws-services-masters MDMS folder:

egov-mdms-data/data/pb/ws-services-masters at master · egovernments/egov-mdms-data

Documents.json

Used to display the order of the files in the Documents section which needs to be uploaded from the Citizen or Employee while creating the Water Service application.

WaterSource.json - Provides details of the different types of water source and their sub types.

sw-services-calculation MDMS folder:

egov-mdms-data/data/pb/sw-services-calculation at master · egovernments/egov-mdms-data

Pipesize.json - Provides the details of the pipe sizes.

Roadtype.json - Provides the details of the different types of the Roads and their cutting charges.

PDF Configurations:

The UI and the PDFService retrieves the Data and Format configurations from the following path:

configs/pdf-service at master · egovernments/configs

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.

Open

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.

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.