Property Services
- Kaviyarasan P
- Sathish P
Overview:
One of the major applications of the eGov stack which helps municipal and citizens to handle property tax payments and other related functions on the property such as assessments, mutation, and so on.
Pre-requisites:
Prior Knowledge of Java/J2EE.
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 the demand-based systems.
Following services should be up and running:
user
MDMS
Persister
Location
Localization
Id-Gen
Billing-service
URL-shortener
Key Functionality:
The Property Service provides multiple functionalities starting from serving as a central repository where property information is registered for reference of citizens and other municipality-provided services such as water connection and sewerage management.
An assessment can be done so as to calculate and pay tax on the property. The different services provided by the property services are
Property Registry
Assessment
Mutation
Bifurcation
consolidation
Registry Explanation:
The registry flow helps the citizen/Employee to create a property in the system with the minimal information required.
Other workflows such as assessment or mutation can be triggered on the existing ACTIVE Property in the registry.
The property can be created, updated, canceled, searched, Followed by the process of Mutation and Assessment.
The same entry in the registry can be referred by other modules for their business purposes(Water charges).
Configuration Details:
MDMS CONFIG: https://github.com/egovernments/egov-mdms-data/tree/DEV/data/pb/PropertyTax
Persister File Config:
The persister File config for property services can be found in the Config repo of eGov Git, which needs to be added in the persister service - property-services-registry.yml
Workflow-configs:
Each flow in property has a workflow associated with it, which can be controlled by the following configs
The Boolean field which can enable/disable Workflow - same field controls the update and create the workflow
name | value | description |
|---|---|---|
is.workflow.enabled | true/false | enable disbale workflow |
PT.CREATE | the name should match the config name in the workflow businessservice JSON
| |
PT.LEGACY | ||
PT.UPDATE |
Workflow Config for property create if the source is from WATER CONNECTION module
For the creation of property from the water and sewerage module, as per the use case mentioned in this ticket, a different workflow config is used.
For each use case, to identify which workflow to use can be identified from this mdms file.
{
"tenantId": "pb",
"moduleName": "PropertyTax",
"PTWorkflow":[
{
"businessService":"PT.CREATEWITHWNS",
"initialAction":"OPEN",
"inWorkflowStatusAllowed":false,
"enable":false
},
{
"businessService":"PT.CREATE",
"initialAction":"open",
"inWorkflowStatusAllowed":true,
"enable":true
}
]
}
For use case 1 which says, The property which is creating from Water and sewerage module should have one step workflow.
for this requirement in the above MDMS file businessService with PT.CREATEWITHWNS object must have enabled the field to set as true.
Then for all the property creation from Water and Sewerage module would have one step workflow and property would be created with an ACTIVE state.
Fields in above MDMS file:
Mdms Fields | Descripton |
|---|---|
businessService | Name of workflow config |
initialAction | Indicate the start(initial) action of the particular workflow mention in businessService. |
inWorkflowStatusAllowed | This field indicate whether the property with application status as “inWorkflow” can be use with water and sewerage connection creation. |
enable | If this filed is set as true, then the other fields associate with the particular object is use for property creation. |
(Note: The above objects indicate each use case mentioned in this ticket, so at a time only one object (use case)enable field must set as true )
Sample workflow config for use case 1 where property creation is from water and sewerage module with one step workflow
{
"BusinessServices": [
{
"tenantId": "pb",
"businessService": "PT.CREATEWITHWNS",
"business": "PT",
"businessServiceSla": null,
"states": [
{
"sla": null,
"state": null,
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"action": "OPEN",
"nextState": "INITIATED",
"roles": [
"CITIZEN",
"WS_CEMP",
"SW_CEMP"
]
}
]
},
{
"sla": null,
"state": "INITIATED",
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"action": "SUBMIT",
"nextState": "APPROVED",
"roles": [
"EMPLOYEE",
"CITIZEN",
"SW_CEMP",
"WS_CEMP"
]
},
{
"action": "BACK",
"nextState": "INWORKFLOW",
"roles": [
"EMPLOYEE",
"CITIZEN",
"SW_CEMP",
"WS_CEMP"
]
}
]
},
{
"sla": null,
"state": "INWORKFLOW",
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"action": "SUBMIT",
"nextState": "APPROVED",
"roles": [
"EMPLOYEE",
"CITIZEN",
"SW_CEMP",
"WS_CEMP"
]
}
]
},
{
"sla": null,
"state": "APPROVED",
"applicationStatus": "ACTIVE",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
}
]
}
]
}
Sample workflow config - (The same PT.CREATE can be used for update workflow also since both involve the same functionality)
{
"RequestInfo": {
"apiId": "Rainmaker",
"action": "",
"did": 1,
"key": "",
"msgId": "20170310130900|en_IN",
"requesterId": "",
"ts": 1513579888683,
"ver": ".01",
"authToken": "b39181b1-5c6b-484a-b825-6be2f62012b8"
},
"BusinessServices": [
{
"tenantId": "pb",
"businessService": "PT.CREATE",
"business": "PT",
"businessServiceSla": null,
"states": [
{
"tenantId": "pb",
"sla": null,
"state": null,
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"actions": [
{
"tenantId": "pb",
"action": "OPEN",
"nextState": "OPEN",
"roles": [
"CITIZEN",
"EMPLOYEE"
]
}
]
},
{
"tenantId": "pb",
"sla": null,
"state": "OPEN",
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"actions": [
{
"tenantId": "pb",
"action": "VERIFY",
"nextState": "DOCVERIFIED",
"roles": [
"PT_DOC_VERIFIER"
]
},
{
"tenantId": "pb",
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"PT_DOC_VERIFIER"
]
},
{
"tenantId": "pb",
"action": "SENDBACKTOCITIZEN",
"nextState": "CORRECTIONPENDING",
"roles": [
"PT_DOC_VERIFIER"
]
}
]
},
{
"tenantId": "pb",
"sla": null,
"state": "DOCVERIFIED",
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"actions": [
{
"tenantId": "pb",
"action": "FORWARD",
"nextState": "FIELDVERIFIED",
"roles": [
"PT_FIELD_INSPECTOR"
]
}
]
},
{
"tenantId": "pb",
"sla": null,
"state": "FIELDVERIFIED",
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"actions": [
{
"tenantId": "pb",
"action": "APPROVE",
"nextState": "APPROVED",
"roles": [
"PT_APPROVER"
]
},
{
"tenantId": "pb",
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"PT_APPROVER"
]
}
]
},
{
"tenantId": "pb",
"sla": null,
"state": "REJECTED",
"applicationStatus": "INACTIVE",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"actions": null
},
{
"tenantId": "pb",
"sla": null,
"state": "APPROVED",
"applicationStatus": "ACTIVE",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"actions": null
},
{
"tenantId": "pb",
"sla": null,
"state": "CORRECTIONPENDING",
"applicationStatus": "INWORKFLOW",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb",
"action": "REOPEN",
"nextState": "OPEN",
"roles": [
"CITIZEN",
"PT_CEMP"
]
},
{
"tenantId": "pb",
"action": "REJECT",
"nextState": "REJECTED",
"roles": [
"CITIZEN",
"PT_CEMP"
]
}
]
}
]
}
]
}
PT.LEGACY workflow config
Notifications :
To enable or disable notifcation
notif.sms.enabled=true
#notif urls - makes use of the UI app host in notification service
egov.notif.commonpay = citizen/egov-common/pay?consumerCode={CONSUMERCODE}&tenantId={TENANTID}
egov.notif.view.property = citizen/property-tax/my-properties/property/{PROPERTYID}/{TENANTID}
egov.notif.view.mutation = citizen/pt-mutation/search-preview?applicationNumber={APPID}&tenantId={TENANTID}
The Current localization messages for notification
Configs in App.props
name | value |
|---|---|
egov.idgen.ack.format | PB-AC-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ACK] |
egov.idgen.mutation.format | PB-MT-[CITY]-[SEQ_EG_PT_MUTATION] |
egov.idgen.assm.format | PB-AS-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ASSM] |
egov.idgen.ptid.format | PB-PT-[cy:yyyy-MM-dd]-[SEQ_EG_PT_PTID] |
citizen.allowed.search.params | accountId,ids,propertyDetailids,mobileNumber,oldpropertyids |
employee.allowed.search.params | accountId,ids,propertyDetailids,mobileNumber,oldpropertyids |
Integration
Integration Scope
Property service can be integrated with any organization or system that wants to maintain a record of the property and collect taxes with ease.
Integration Benefits
Easy to create and simple process of self-assessment to avoid the hassle.
Helps maintain property data which can be used in the integration of other essential services like asset management, water connection and so on.
provides additional functionalities like mutation, assessment of properties.
Steps to Integration
Customer can create a property using the
/property/_createSearch the property using
/property/_searchendpoint/property/_updateendpoint to update the property demand as per need.Mutation can be carried out with the help of
/property/_updateitself, no extra API is needed.
Reference Docs:
Doc Links
Title | Link |
USER Service | |
url-shortening | |
MDMS | |
Billing-service | |
Location | |
Workflow | |
Persister |
|
Localization |
|
Id-Gen service |
|
API LIST:
Title | Link |
/Property/_create | |
/Property/_update | |
/property/_search |