...

One of the major application of the eGov stack which helps municipal and citizen to handle property tax payment and other related functions on the property such as assessments, mutation and so on.

...

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 eGov-mdms service, eGov-persister, eGov-user, eGov-location, eGov-localization, eGov-idgen, billing-service and eGov-URL-shortener.

FUNCTIONALITY:

The Property service Service provides multiple functionality functionalities starting from serving as a central repository where property information are is registered for reference of citizen 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

...

Mutation

Bifurcation

consolidation

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

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.

https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/property-services/property-services.yml

https://github.com/egovernments/municipal-services/blob/master/docs/property-services/Assessment.yml

Incase the url is unavailable, please go to the docs folder of municipal-services git repo

The postman collection of the service Property registry

https://www.getpostman.com/collections/02d01e7b46c79c140863

The variables in the Application.properties to be updated are as follows

###### kafka topics persister configs for eGov persister

...

persister.cancel.property.topic=cancel-property-registry
persister.cancel.property.assessment.topic=cancel-property-assessment

egov.pt.assessment.create.topic=save-property-assessment
egov.pt.assessment.update.topic=update-property-assessment

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, cancelled, searched, Followed by process of Mutation and Assessment.
The same entry in registry can be referred by other modules for their business purposes(Water charges).

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

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.

https://github.com/egovernments/municipal-services/blob/master/docs/property-services/property-services.yml

https://github.com/egovernments/municipal-services/blob/master/docs/property-services/Assessment.yml

In case the URL is unavailable, please go to the docs folder of the municipal-services git repo

The Postman collection of the service Property registry

https://www.getpostman.com/collections/02d01e7b46c79c140863

########## 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 egov-persister service.

https://github.com/egovernments/configs/blob/master/egov-persister/property-services-registry.yml

The variables in the Application.properties to be updated are as follows

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

idGen Id formats

egov.idgen.ack.name=pt.acknowledgementnumber
egov.idgen.ack.format=PB-AC-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ACK]

...

eGov - workflow

...

eGov - workflow
workflow.host = https://egov-micro-dev.egovernments.org/
eGov - user
egov.user.host=https://egov-micro-dev.egovernments.org
boundary service
egov.location.host=https://egov-micro-dev.egovernments.org
pt- Calculation service
egov.calculation.host = https://egov-micro-dev.egovernments.org
localization service
egov.localization.host = https://egov-micro-dev.egovernments.org
billing-service
egbs.host=https://egov-micro-dev.egovernments.org/eGov
Url- userShortner
egov.

...

url.shortner.host=

...

http://egov-

...

url-

...

boundary service
egov.location.host=https://egov-micro-dev.egovernments.org
pt- Calculation service

egov.calculation.host = http://pt-calculator-v2:8080

localization service

egov.localization.host = https://egov-micro-dev.egovernments.org

Property Search Parameters config (filter for search based on fields by user Type)
citizen.allowed.search.params = accountId,ids,propertyDetailids,mobileNumber,oldpropertyids
employee.allowed.search.params = accountId,ids,propertyDetailids,mobileNumber,oldpropertyids

Explanation for Registry:

The registry flow 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 registry. The registry entry can be created, updated and cancelled, searched. The same entry in registry can be referred by other modules for their business purposes.

Assessment APIs:

Assessment is a snapshot of Property for a given transaction on that Property. These APIs provide functionalities to create/update/search the assessments. An assessment cannot exist without a property.

...

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

Configs:

...

shortening.egov:8080

###### kafka topics persister configs for eGov persister

persister.save.property.topic=save-property-registry
persister.update.property.topic=update-property-registry

persister.cancel.property.topic=cancel-property-registry
persister.cancel.property.assessment.topic=cancel-property-assessment

egov.pt.assessment.create.topic=save-property-assessment
egov.pt.assessment.update.topic=update-property-assessment

Payment topic to udate workflow to paid status
kafka.topics.receipt.create=egov.collection.payment-create

####### Id-Gen Configs for Business ids

egov.idgen.ack.name=pt.acknowledgementnumber
egov.idgen.ack.format=PB-AC-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ASSMACK]

PERSISTER:
https://raw.githubusercontent.com/egovernments/configs/master/egov-persister/assessment-persister.yml?token=AE4Z2KFWEQBDCUY6AZLGGIK6AM3QQ

KAFKA TOPICS:
save-pt-assessment
update-pt-assessment

Services required to be running:
egov-mdms-service
egov-idgen
egov-persister

egov-workflow-v2

Workflow integration can be controlled by the following two properties:

Code Block
assessment.workflow.enabled=true assessment.workflow.trigger.param=usageCategory,occupancyType,occupancyDate

The first property switches workflow on or off, while the second property provides a way to control which field change can trigger workflow. A businessService needs to be created using the workflow

/egov-workflow-v2/egov-wf/businessservice/_create API .

Sample businessService create API body for Assessment workflow:

...

egov.idgen.mutation.name=pt.mutation.number
egov.idgen.mutation.format=PB-MT-[CITY]-[SEQ_EG_PT_MUTATION]

egov.idgen.assm.name=pt.assessmentnumber
egov.idgen.assm.format=PB-AS-[cy:yyyy-MM-dd]-[SEQ_EG_PT_ASSM]

egov.idgen.ptid.name=pt.propertyid
egov.idgen.ptid.format=PB-PT-[cy:yyyy-MM-dd]-[SEQ_EG_PT_PTID]

Property Search Parameters config (filter for search based on fields by user Type)
citizen.allowed.search.params = accountId,ids,propertyDetailids,mobileNumber,oldpropertyids
employee.allowed.search.params = accountId,ids,propertyDetailids,mobileNumber,oldpropertyids

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 workflow
is.workflow.enabled=false

Name of the business code in the workflow, this should be set to matching value to the config businessService field in workflow master
property.workflow.name=PT.CREATE
property.update.workflow.name=PT.CREATE

Sample workflow config

Code Block

language	json

{
  "tenantId": "pb",
      "businessService": "ASMTPT.CREATE",
      "business": "pt-servicesPT",
      "businessServiceSla"businessServiceSla": 172800000null,
   
  "states": [
    {
   {   "tenantId": "pb",
      "sla": null,
   
      "state": null,

         "applicationStatus": null"INWORKFLOW",
          "docUploadRequired": false,
  
       "isStartState": true,
   
      "isTerminateState": false,
   
      "isStateUpdatableactions": true,[
        {
  "actions": [       "tenantId": "pb",
    {      "action": "OPEN",
       "action": "INITIATE",
              "nextState": "INITIATEDOPEN",
  
           "roles": [
                "CITIZEN",
                "PT_CEMP"
"EMPLOYEE"
             ]
 
          }
  
       ]
   
    },
    {
   {   "tenantId": "pb",
      "sla": null,
          "state": "INITIATEDOPEN",
          "applicationStatus": "INITIATEDINWORKFLOW",
          ""docUploadRequired": false,

         "isStartState": true,
 
        "isTerminateState": false,
  
       "actions": [
        {
   {       "tenantId": "pb",
          "action": "APPLYVERIFY",
              "nextState": "APPLIEDDOCVERIFIED",

             "roles": [
 
              "CITIZEN","PT_DOC_VERIFIER"
          ]
     "PT_CEMP"   }
      ]
    ]},
    {
       }"tenantId": "pb",
      "sla": null,
    {        "state": "DOCVERIFIED",
      "actionapplicationStatus": "INITIATEINWORKFLOW",
      "docUploadRequired": false,
      "nextStateisStartState": "INITIATED"false,
      "isTerminateState": false,
      "rolesactions": [
        {
       "CITIZEN",   "tenantId": "pb",
          "action":  "PT_CEMPFORWARD",
          "nextState": "FIELDVERIFIED",
  ]        "roles": [
   }         "PT_FIELD_INSPECTOR"
 ]         },]
        {}
      ]
   "sla": null},
    {
      "statetenantId": "APPLIEDpb",
      "sla": null,
      "applicationStatusstate": "APPLIEDFIELDVERIFIED",
   
      "docUploadRequiredapplicationStatus": false,
   "INWORKFLOW",
      "isStartStatedocUploadRequired": false,
          "isTerminateStateisStartState": false,
  
       "isStateUpdatableisTerminateState": truefalse,
          "actions": [
            {
          "tenantId": "pb",
          "action": "FORWARDAPPROVE",
              "nextState": "FIELDINSPECTIONPENDINGPAYMENT",
 
            "roles": [
                "PT_DOC_VERIFIER"
   APPROVER"
          ]
        },
   },     {
       {   "tenantId": "pb",
          "action": "REJECT",

             "nextState": "REJECTED",
              "roles": [
  
             "PT_DOC_VERIFIERAPPROVER"
          ]
   ]     }
      ]
},    },
        {
      "tenantId": "pb",
      "actionsla" : "SENDBACKTOCITIZEN"null,
      "state": "PENDINGPAYMENT",
      "nextStateapplicationStatus" : "INITIATEDINWORKFLOW",
      "docUploadRequired": false,
      "rolesisStartState":["PT_DOC_VERIFIER"]
 false,
      "isTerminateState": false,
   }   "actions": [
      ]  {
      },      "tenantId": "pb",
  {          "action": "slaPAY": null,
          "statenextState": "REJECTEDAPPROVED",
          "applicationStatusroles": "REJECTED",[
            "isStateUpdatableEMPLOYEE":,
 false,           "docUploadRequiredCITIZEN":
false,           "isStartState": false,]
         }
 "isTerminateState": true    ]
    },
    {
   {   "tenantId": "pb",
      "sla": 86400000null,
 
        "state": "FIELDINSPECTIONREJECTED",
          "applicationStatus": "FIELDINSPECTIONINACTIVE",
          "docUploadRequired"docUploadRequired": false,

         "isStartState": false,
 
        "isStateUpdatableisTerminateState": true,
      "actions": null
  "isTerminateState": false  },
    {
      "actionstenantId": ["pb",
      "sla": null,
    {       "state": "APPROVED",
       "actionapplicationStatus": "FORWARDACTIVE",
      "docUploadRequired": false,
      "nextStateisStartState": "PENDINGAPPROVAL"false,
      "isTerminateState": true,
      "rolesactions": [
                "PT_FIELD_INSPECTOR"
              ]
     null
      },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "PT_FIELD_INSPECTOR"
              ]
            },
            {
              "action": "SENDBACK",
              "nextState": "APPLIED",
              "roles": [
                "PT_FIELD_INSPECTOR"
              ]
            }
          ]
        },
        {
          "sla": 43200000,
          "state": "PENDINGAPPROVAL",
          "applicationStatus": "PENDINGAPPROVAL",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": false,
          "isTerminateState": false,
          "actions": [
            {
              "action": "APPROVE",
              "nextState": "PENDINGPAYMENT",
              "roles": [
                "PT_APPROVER"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "PT_APPROVER"
              ]
            },
            {
              "action": "SENDBACK",
              "nextState": "FIELDINSPECTION",
              "roles": [
                "PT_APPROVER"
              ]
            }
          ]
        },
        {
          "sla": 43200000,
          "state": "PENDINGPAYMENT",
          "applicationStatus": "PENDINGPAYMENT",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "PAY",
              "nextState": "APPROVED",
              "roles": [
                "CITIZEN",
                "PT_CEMP",
                "SYSTEM_PAYMENT"
              ]
            },
            {
              "action": "ADHOC",
              "nextState": "PENDINGPAYMENT",
              "roles": [
                "PT_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "APPROVED",
          "applicationStatus": "APPROVED",
          "isStateUpdatable": false,
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": true
        }
      ]
    }
  ]
}

Other system level configs are same as PT-Registry as mentioned above.

Mutation calculator:

Calculation Logic

The calculation logic for mutation fee depends on the usage type of property (RESIDENTIAL , NON RESIDENTIAL etc ) and current market value of the property.

Usage type	Minimum Market value	Maximum Market Value	Rate Percentage	Fixed amount	Calculation Type
Residential	0	X lacs	A% of CMV	INR G	FLAT
Non -Residential	0	X lacs	E% of CMV	INR Q	RATE
Residential	X+1 Lacs	Y Lacs	B% of CMV	INR H	FLAT
Non -Residential	X+1 Lacs	Y Lacs	B% of CMV	INR H	RATE
Residential	Y+1 Lacs	>Y+1Lacs	D% of CMV	INR L	FLAT
Non -Residential	Y+1 Lacs	>Y+1Lacs	C% of CMV	INR I	RATE

If the current market value (CMV) of the property comes in between minimum and maximum market value range of billing slab and the usage type of property match with the usage type for that billing slab then the mutation fees for that property is the amount mentioned in that particular billing slab.

Further there are two calculation types which are FLAT and RATE which has to set by state/ulb for their billing slab for property mutation. If the calculation type is set as FLAT then mutation fee is the fixed amount mentioned in billing slab which is used for the property.

If the calculation type is set as RATE the Mutation fee is X% of current market value, where X is percentage rate mentioned in billing slab which is used for the property.

Other factors influencing calculation can be :

Ownership type
Property type
Locality

Rebate and Penalty

When the property is registered for mutation/transfer of ownership and all the document is submitted, then the mutation fees has to pay within specified period of time of property mutation registration date. If a person fails to pay the fees amount before the deadline date, then some penalty charges has to pay. Penalty charge is Y% of tax amount. The penalty percentage is set by the state/ulb. If a person pays the fees amount within the specified month of property mutation registration date, then a certain amount is rebated from tax amount. Rebate charge is Z% of tax amount. The rebate percentage is set by state/ulb.

Note: For mutation fees calculation, document date value (means the date at which property is registered for mutation), market value of property, usage type value of property is essential.

API contract

https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/property-services/property-mutation-fees-calculator_API_Contract.yml

Postman collection for property mutation billing slab

https://www.getpostman.com/collections/02965abc6345b5e1a633

...

Notification:

Payment Notification:

Code Block
] }

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

Code Block

language	json

{
  "messages": [
      {
          "code": "PT_NOTIF_WF_MT_OPEN",
          "message": "Dear {OWNER_NAME}, Your application to edit ownership details of property ID {PROPERTYID} has been submitted successfully. Your application no. for future reference is {APPID}. You can track your application on the link given below - {MTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN"
      },
      {
          "code": "PT_NOTIF_NOTIFICATIONWF_MT_PAYMENT_FAIL",STATE_CHANGE",
          "message": "Dear Citizen, Your payment of Rs. <insert amount to pay> for Property Tax Unique ID <insert ID> has failed. Your assessment is pending. Please try again. Ignore this message if you have completed your payment{OWNER_NAME}, Status for your application no. {APPID} for property {PROPERTYID} to edit ownership has been changed to {STATUS}. You can paytrack your application on Propertythe Taxlink onlinegiven herebelow - <payLink>{MTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN"
      },
      {
          "code": "PT_NOTIF_WF_NOTIFICATIONMT_PAYMENT_OFFILEPENDING",
   
  "message": "Dear Citizen,  Your Property Tax payment of Rs. <amount>  has been accepted. Mode of Payment"message": <insert mode of payment> Pending Amount: <Enter pending amount>.",
      "module": "rainmaker-pt",
      "locale": "en_IN"
    },
    {
      "code": "PT_NOTIFICATION_PAYMENT_ONLINE","Dear {OWNER_NAME}, Payment is pending for your application no. {APPID} for property ID {PROPERTYID} to edit ownership. You can pay your mutation fee on the below link - {PAYLINK} or visit your ULB to pay your dues. Thank you",
          "messagemodule": "Dear Citizen"rainmaker-pt",
Your payment of Rs.< insert amount paid> with payment transaction id < insert payment transaction id from PG> has been made successfully. Assessment for Property Tax Unique ID <insert Property Tax Assessment ID>  was succesful. Property Tax due is Rs.<pt due>.","locale": "en_IN"
      },
      {
          "code": "PT_NOTIF_WF_MT_PAID",
          "modulemessage": "rainmaker-pt",
      "locale": "en_IN"
    },
    {
      "code": "PT_NOTIFICATION_PAYMENT_PARTIAL_OFFLINE",Dear {OWNER_NAME}, You’ve successfully paid mutation fee - INR {AMOUNT} for application no. {APPID} for property ID {PROPERTYID}. You can download your receipt on the below link - {MTURL} Thank you ",
           "messagemodule": "Dear Citizen,  Your Property Tax payment of Rs. <amount>  has been accepted. Mode of Payment: <insert mode of payment> Pending Amount: <Enter pending amount>. You can pay your Property Tax online here - <payLink>","rainmaker-pt",
          "locale": "en_IN"
      },
      {
          "modulecode": "rainmaker-ptPT_NOTIF_WF_MT_APPROVED",
          "localemessage": "en_IN"
    },
    {
      "code": "PT_NOTIFICATION_PAYMENT_PARTIAL_ONLINE",
      "message": "Dear Citizen, Your payment of Rs.< insert amount paid> with payment transaction id < insert payment transaction id from PG> has been made successfully. Assessment for Property Tax Unique ID <insert ID>  was succesful. Property Tax due is Rs.<pt due>. You can pay your Property Tax here - <payLink>",
      "module": "rainmaker-pt",Dear {OWNER_NAME}, Your property ownership has been changed as per the application no. {APPID} for property {PROPERTYID}. You can download your mutation certificate on the below link - {MTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN"
      },
      {
          "code": "PT_NOTIF_WF_MT_NONE",
          "localemessage": "en_IN"
    }

Assessment Notification:

...

Dear {OWNER_NAME}, Your property with property-id {PROPERTYID} has been mutated. You can view your property on the link given below - {MTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN"
      },

...

code": "

...

PT_NOTIF_WF_OPEN",

...

message": "

...

Dear {OWNER_NAME}, Your application to

...

{updated/created} property with Id {PROPERTYID}

...

has been submitted successfully. Your application no. for future reference is {APPID}. You can track your application on the link given below - {PTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN

...

"
      },
      {
          "code": "

...

PT_NOTIF_WF_STATUS_CHANGE",
          "message": "Dear {OWNER_NAME}, Status for

...

your

...

application

...

no. {

...

APPID} for

...

 property {PROPERTYID} to {updated/created} property has been changed to {STATUS}. You can track your application on the link given below - {PTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN"
      },
      {
          "code": "

...

PT_NOTIF_

...

WF_

...

APPROVED",
          "message": "Dear {OWNER_NAME}, Your

...

 property has been {updated/created} as per the application no. {APPID} for

...

property

...

PROPERTYID}. You can view your property

...

on the link given below - {PTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN"
      },
      {
          "code": "

...

PT_NOTIF_WF_UPDATE_NONE",
          "message": "Dear {OWNER_NAME}, Your

...

 property with property-id {PROPERTYID} has been {updated/created}. You can view your property on the link given below - {PTURL} Thank you",
          "module": "rainmaker-pt",
          "locale": "en_IN"
      }

...

]
}

Versions Compared

Old Version 8

New Version 9

Key

######## URLs for the external API references

Mutation calculator:

Calculation Logic

Notification:

Payment Notification:

Assessment Notification:

Page Comparison

Versions Compared

Old Version 8

New Version 9

Key

######## URLs for the external API references

Mutation calculator:

Calculation Logic

Notification:

Payment Notification:

Assessment Notification: