Overview
Sewerage Calculator Service 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 sewerage charge(one-time cost) which involves cost like road-cutting charge , form fee , scrutiny fee etc.
Pre-requisites
Before you proceed with the documentation, make sure the following pre-requisites are met -
Java 8
Kafka server is up and running
egov-persister service is running and has sewerage service persister configs path added in it
PSQL server is running and database is created to store sewerage connection / application data
Following services should be up and running:
egov-perister
egov-mdms
sw-services
billing-service
Key Functionalities
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 sewerage 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:
Sewerage charge calculation
Demand generation(here as its always non-metered demand will be generated based on time period)
Sewerage charge estimation(one-time cost which involves cost like road-cutting charge , form fee , scrutiny fee etc.)
Deployment Details
Deploy the latest version of sw-service and sw-calculator
Add sewerage-persist.yml file in config folder in git and add that path in persister . (The file path is to be added in environment yaml file in param called
persist-yml-path)
Configuration Details
MDMS Configuration
Billing Slabs:
Criteria :
connection type
building type
calculation attribute
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.
{
"tenantId": "pb",
"moduleName": "sw-services-calculation",
"SCBillingSlab": [
{
"id": "1",
"buildingType": "RESIDENTIAL",
"calculationAttribute": "No. of water closets",
"connectionType": "Non Metered",
"minimumCharge": 0,
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 15
}
]
},
{
"id": "2",
"buildingType": "RESIDENTIAL",
"calculationAttribute": "No. of toilets",
"connectionType": "Non Metered",
"minimumCharge": 0,
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 15
}
]
},
{
"id": "3",
"buildingType": "NONRESIDENTIAL",
"calculationAttribute": "No. of water closets",
"connectionType": "Non Metered",
"minimumCharge": 0,
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 30
}
]
},
{
"id": "4",
"buildingType": "NONRESIDENTIAL",
"calculationAttribute": "No. of toilets",
"connectionType": "Non Metered",
"minimumCharge": 0,
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 30
}
]
},
{
"id": "5",
"buildingType": "Commercial",
"calculationAttribute": "No. of water closets",
"connectionType": "Non Metered",
"minimumCharge": 0,
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 30
}
]
},
{
"id": "6",
"buildingType": "Commercial",
"calculationAttribute": "No. of toilets",
"connectionType": "Non Metered",
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 30
}
]
},
{
"id": "7",
"buildingType": "Government",
"calculationAttribute": "No. of water closets",
"connectionType": "Non Metered",
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 30
}
]
},
{
"id": "8",
"buildingType": "Government",
"calculationAttribute": "No. of toilets",
"connectionType": "Non Metered",
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 30
}
]
},
{
"id": "9",
"buildingType": "Partly Commercial",
"calculationAttribute": "No. of water closets",
"connectionType": "Non Metered",
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 25
}
]
},
{
"id": "10",
"buildingType": "Partly Commercial",
"calculationAttribute": "No. of toilets",
"connectionType": "Non Metered",
"slabs": [
{
"from": 0,
"to": 1000000000,
"charge": 25
}
]
},
{
"id": "11",
"buildingType": "RESIDENTIAL",
"calculationAttribute": "Flat",
"connectionType": "Non Metered",
"minimumCharge": 100,
"slabs": []
},
{
"id": "12",
"buildingType": "NONRESIDENTIAL",
"calculationAttribute": "Flat",
"connectionType": "Non Metered",
"minimumCharge": 250,
"slabs": []
},
{
"id": "13",
"buildingType": "Commercial",
"calculationAttribute": "Flat",
"connectionType": "Non Metered",
"minimumCharge": 250,
"slabs": []
},
{
"id": "14",
"buildingType": "Government",
"calculationAttribute": "Flat",
"connectionType": "Non Metered",
"minimumCharge": 350,
"slabs": []
},
{
"id": "15",
"buildingType": "Partly commercial",
"calculationAttribute": "Flat",
"connectionType": "Non Metered",
"minimumCharge": 200,
"slabs": []
}
]
}
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 sw-services-calculation.
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 :
{
"tenantId": "pb",
"moduleName": "sw-services-calculation",
"Interest": [
{
"rate": 5,
"minAmount": null,
"applicableAfterDays":0,
"flatAmount": null,
"maxAmount": null,
"fromFY": "2019-20",
"startingDay": "1/01/2019"
}
]
}
Penalty:
Below is a sample of master data JSON for penalty :
{
"tenantId": "pb",
"moduleName": "sw-services-calculation",
"Penalty": [
{
"rate": 10,
"minAmount": null,
"applicableAfterDays": 0,
"flatAmount": null,
"fromFY": "2019-20",
"startingDay": "1/01/2019"
}
]
}
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.
Actions & Role Action Mapping
Actions
[
{
"id": {{PLACEHOLDER1}},
"name": "Sewerage Calculation",
"url": "/sw-calculator/sewerageCalculator/_calculate",
"displayName": "Sewerage Calculation",
"orderNumber": 0,
"enabled": false,
"serviceCode": "sw-calculator",
"code": "null",
"path": ""
},
{
"id": {{PLACEHOLDER2}},
"name": "Calculate Fee For Sewerage Application",
"url": "/sw-calculator/sewerageCalculator/_estimate",
"displayName": "Fee Calculation For Sewerage Application",
"orderNumber": 0,
"enabled": false,
"serviceCode": "sw-calculator",
"code": "null",
"path": ""
},
{
"id": {{PLACEHOLDER3}},
"name": "Add adhoc tax to sewerage",
"url": "/sw-calculator/sewerageCalculator/_applyAdhocTax",
"displayName": "Add adhoc tax",
"orderNumber": 0,
"enabled": false,
"serviceCode": "sw-calculator",
"code": "null",
"path": ""
}
]
Role Action Mapping
[
{
"rolecode": "SW_CEMP",
"actionid": {{PLACEHOLDER1}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_CLERK",
"actionid": {{PLACEHOLDER1}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_DOC_VERIFIER",
"actionid": {{PLACEHOLDER1}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_FIELD_INSPECTOR",
"actionid": {{PLACEHOLDER1}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_APPROVER",
"actionid": {{PLACEHOLDER1}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_CEMP",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_CLERK",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_DOC_VERIFIER",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_FIELD_INSPECTOR",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_APPROVER",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "CITIZEN",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
},
{
"rolecode": "SW_CEMP",
"actionid": {{PLACEHOLDER2}},
"actioncode": "",
"tenantId": "pb"
}
]
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
"demandDetails": [
{
"id": "77ba1e93-a535-409c-b9d1-a312c409bd45",
"demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
"taxHeadMasterCode": "SEWERAGE_CHARGE",
"taxAmount": 120,
"collectionAmount": 120,
"additionalDetails": null,
"auditDetails": {
"createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
"lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
"createdTime": 1583675275873,
"lastModifiedTime": 1583675298705
},
"tenantId": "pb.amritsar"
}
],
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:
"demandDetails": [
{
"id": "77ba1e93-a535-409c-b9d1-a312c409bd45",
"demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
"taxHeadMasterCode": "SEWERAGE_CHARGE",
"taxAmount": 120,
"collectionAmount": 0,
"additionalDetails": null,
"auditDetails": {
"createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
"lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
"createdTime": 1583675275873,
"lastModifiedTime": 1583675298705
},
"tenantId": "pb.amritsar"
},
{
"id": "0d83f4b0-6442-11ea-bc55-0242ac130003 ",
"demandId": "687c3176-305b-461d-9cec-2fa26a30c88f",
"taxHeadMasterCode": "SEWERAGE_CHARGE",
"taxAmount": 30,
"collectionAmount": 0,
"additionalDetails": null,
"auditDetails": {
"createdBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
"lastModifiedBy": "04956309-87cd-4526-b4e6-48123abd4f3d",
"createdTime": 1583675275873,
"lastModifiedTime": 1583675298705
},
"tenantId": "pb.amritsar"
}
],
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.
Scheduler for generating the demand:
Description :
For generating the demand for non metered connection we have a feature for generating the demand in batch. The scheduler is responsible for generating the demand based on the tenant.
The scheduler can be hit by scheduler API or we can schedule cron job or we can put config to kubectl which will hit scheduler based on config.
After the scheduler been hit we will search the list of the tenant (city) present in the database.
After getting the tenants we will pickup tenant one by one and generate the demand for that tenant.
We will load the consumer codes for the tenant and push the calculation criteria to Kafka. Calculation criteria contain minimal information (We are not pushing large data to Kafka), calculation criteria contain consumer code and one boolean variable.
After pushing the data into Kafka we are consuming the records based on the batch configuration. Ex:-> if the batch configuration is 50 so we will consume the 50 calculation criteria at a time.
After consuming the record(Calculation criteria) we will process the batch for generating the demand. If the batch is successful so will log the consumer codes which have been processed.
If some records failed in batch so we will push the batch into dead letter batch topic. From the dead letter batch topic, we will process the batch one by one.
If the record is successful we will log the consumer code, If the record is failed so we will push the data into a dead letter single topic.
Dead letter single topic contains information about failure records in Kafka.
Use cases:
If the same job trigger multiple time what will happen?
If the same job triggers multiple times we will process again as mentioned above but at the demand level we will check the demand based on consumer code and billing period, If demand already exists then we will update the demand otherwise we will create the demand.
Are we maintaining success or failure status anywhere?
Currently, we are maintaining the status of failed records in Kafka.
Configuration :
We need to configure the batch size for Kafka consumer. This configuration is for how much data will be processed at a time.
sw.demand.based.batch.size=10
Integration
Integration Scope
sw-calculator will be integrated with sw-service. sw-services internally invoke the sw-calculator service to calculate and generate demand for the charges.
Integration Benefits
SW calculator application is used to calculate the sewerage application one time Fees and connection charges based on the different billing slabs that's why the calculation and demand generation logic will be separate out from SW service.
So in future, if calculation logic need to modify then changes can be carry out for each implementation without modifying the SW service.
Steps to Integration
To Activate the Sewerage Service application, the user needs to pay the ONE_TIME_FEE for the connection. To calculate the ONE_TIME_FEE
sw-calculator/sewerageCalculator/_estimateAPI is use.To generate the demand for non-metered sewerage connection
/sw-calculator/sewerageCalculator/_calculateAPI is use.User can pay partial / full / advance amount for the Non-Metered connection bill. In these cases, Billing service would call back
/sw-calculator/sewerageCalculator/_updateDemandAPI to update the details of the demand generated./sw-calculator/sewerageCalculator/_jobschedulerAPI is use to generate demand for Non-metered connections. This API can be called periodically./sw-calculator/sewerageCalculator/_applyAdhocTaxAPI is use to add Rebate or Penalty on any bill and based on that the bill amount will be adjusted.
Reference Docs
Doc Links
Title | Link |
API Swagger Contract | |
Sewerage Service Document |
API List
Title | Link |
| |
| |
| |
| |
|
(Note: All the API’s are in the same postman collection therefore same link is added in each row)
Add Comment