BPA Service

Description

Construction or renovation of buildings is regulated by Municipal Body in India. One must  get permission from ULB prior to construction . This process involves submitting the building plan to ULB along with other documents, ULB verifies the  plan with other documents and approves the construction. The document which authorizes the construction is called “Permit Order” One must have this permit order with him till the completion of construction. ULB officials  will inspect various stages of construction and make sure it is compliance to the plan . When construction completed ,after inspection Secretary provides “Completion certificate” and finally will provide “Occupancy Certificate”.  This entire process is known as “Building Plan Approval”.

Functionality:

This section covers the high-level details of the functionalities available in the Building Plan Application system.

• Centralized login page for citizen, official and stakeholders

• Citizen functionalities

• Online application submission - New construction

• Occupancy certificate request

• FieldInspection Report Capture

• Pay fee online and generate permit order online

• Inspection of applications and online status

• Configurable workflow

• Auto fee calculation

• Online and off line payment collection

• Rejection process

• Revocation process

• Configurable functionalities

System 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,dcr, land-services, bpa-calculator will be helpful.

Setup and usage:

The Application is present among the municipal services group of applications available in the eGov-services git repository with the folder name bpa-services .  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 Swagger API for YAML file details. Link - API Specs.

Application.properties File Information:

Here we are listing the configs apart from dependent service host, url’s, DB and Flyway configs.

• kafka topics persister configs for eGov persister to save and update BPA Data

  • persister.save.buildingplan.topic=save-bpa-buildingplan

  • persister.update.buildingplan.topic=update-bpa-buildingplan

  • persister.update.buildingplan.workflow.topic=update-bpa-workflow

  • persister.update.buildingplan.adhoc.topic=update-bpa-adhoc-buildingplan

• Receipt kafka topics where BPA application listens to move the application Status after payment completion

  • kafka.topics.receipt.create=egov.collection.payment-create

• Config for Demand Business service codes for different fees to be paid for BPA

  • egov.receipt.businessservice=

    • BPA.NC_APP_FEE := Building Plan Approval Application Fee

    • BPA.NC_SAN_FEE := Building Plan Approval Sanction Fee

    • BPA.LOW_RISK_PERMIT_FEE := Building Plan Approval Low Risk Permit Fee

    • BPA.NC_OC_APP_FEE := Building Plan Approval Occupancy Certificate Application Fee

    • BPA.NC_OC_SAN_FEE := Building Plan Approval Occupancy Certificate Sanction Fee

• Application and Permit Number Formats

  • egov.idgen.bpa.applicationNum.format=PB-BP-[cy:yyyy-MM-dd]-[SEQ_EG_BP_APN]

  • egov.idgen.bpa.permitNum.format=PB-BP-[cy:yyyy-MM-dd]-[SEQ_EG_BP_PN]

• SMS Notification Topic to push the SMS and Notification’s to be sent by BPA module

  • kafka.topics.notification.sms=egov.core.notification.sms

• Payment Notification Config

  • egov.ui.app.host=https://egov-micro-dev.egovernments.org

  • egov.usr.events.create.topic=persist-user-events-async

  • egov.usr.events.pay.link=citizen/otpLogin?mobileNo=$mobile&redirectTo=egov-common/pay?consumerCode=$applicationNo&tenantId=$tenantId&businessService=$businessService

  • egov.usr.events.pay.code=PAY

• List of Application Statuses on which payment notification to be sent

  • egov.usr.events.pay.triggers=PENDING_SANC_FEE_PAYMENT,PENDING_APPL_FEE,PENDING_FEE

• Validity of the permit order generated in no of months

  • egov.bpa.validity.date.in.months=36

• Workflow code for the combination of applicationType , ServiceType

  • appSrvTypeBussSrvCode={"BUILDING_PLAN_SCRUTINY":{"NEW_CONSTRUCTION":"BPA,BPA_LOW"},"BUILDING_OC_PLAN_SCRUTINY":{"NEW_CONSTRUCTION":"BPA_OC"}}

• Application Status on which SKIP_PAYMENT action to be considered

  • egov.bpa.skippayment.status=PENDING_APPL_FEE,PENDING_SANC_FEE_PAYMENT,PENDING_FEE

• Business Service Code for WorkflowCode and Application Status

  • workflowStatusFeeBusinessSrvMap={"BPA":{"PENDING_APPL_FEE":"BPA.NC_APP_FEE","PENDING_SANC_FEE_PAYMENT":"BPA.NC_SAN_FEE"},"BPA_LOW":{"PENDING_FEE":"BPA.LOW_RISK_PERMIT_FEE"},"BPA_OC":{"PENDING_APPL_FEE":"BPA.NC_OC_APP_FEE","PENDING_SANC_FEE_PAYMENT":"BPA.NC_OC_SAN_FEE"}}

• NOC application Integration configs

  • Config to validate the status of applicable noc’s status to allow application to move forward from NOC_VERIFICATION_PENDING Workflow State

    • validate.required.nocs.statuses=APPROVED,AUTO_APPROVED,REJECTED,VOIDED

  • NOC workflow initiate action code to initiate the workflow of the NOC when appliation reachers the respective nocTrigerState

    • egov.noc.initiate.action=INITIATE

  • NOC workflow void action code to void the applicable NOC’s, when the application moved to REJECTED State

    • egov.noc.void.action=VOID

  • NOC workflow action coes for AutoAprove to auto approve offline NOC , while moving from NOC_VERIFICATION_PENDING to next state

    • egov.noc.autoapprove.action=AUTO_APPROVE
      
      

external API references:

• egov-user - ( Manage user )

• tl-services - Stakeholder Registration ( Registration process of Stakeholder is handled by this service )

• egov-user-event ( What’s New and Events )

• egov-filestore ( To store the documents uploaded by the user )

• egov-idgen ( To generate the application No, Permit No )

• egov-indexer ( To index the bpa data )

• egov-localization ( To use the localized messages )

• egov-location ( To store the address locality )

• egov-mdms ( Configurations/master data used in the application is served by MDMS )

• egov-notification-sms ( Service to send SMS to the users involved in the application )

• egov-persister ( Helps to persist the data )

• egov-searcher ( Search query used to simply the search )

• egov-workflow-v2 ( Workflow configuration for different BPA application is configured )

• pdf-service ( Receipt’s, permitorder etc.. and prepared )

• billing-service ( Create demands and bills for the fees to be collected )

• collection-services ( Create receipt for the payment received for the bills )

• bpa-calculator ( Calculates the fees to be collected at different stages)

• land-services ( land information related to BPA application is stored )

• dcr-services ( get and validate Edcr data )

• noc-services ( NOC application )

Configuration:

BPA Specific Mdms configuration:

MDMS Github Repo

Under the data/<state code> folder you can find the BPA which has all the MDMS JSON’s

master-config.json for BPA

MDMS Details

Access MDMS Config

Action Test : URL Actions adding

action-test.json

Access to the Roles for the above Actions

roleacton.json

Billing Service MDMS Config

BusinessService.json

BusinessService Config for Fee’s to be collected

Application Fee, Sanction Fee BPA High/Medium Risk

Application Fee, Sanction Fee for BPA Low Risk

Application Fee, Sanction Fee for BPA OC

TaxHead MDMS

TaxHeader.json

Tax Head for BPA High/Medium Risk

TaxHead config for BPA Low Risk

TaxHead config for BPA OC

TaxPeriod MDMS Config

TaxPeriod.json

TaxPeriod MDMS for BPA High/Medium Risk

TaxPeriod MDMS for BPA Low Risk

TaxPeriod Config for BPA OC

ID Gen Config for BPA Numbers

idFormats.json

BPA Application Number format Config

BPA Permit Number format Config

BPA Receipt Number format config

BPA OC Receipt Number format config

Persister configuration:

BPA Persister YAML

Indexer Configuration:

BPA Indexer YAML

Locality Search Configuration:

Setup the locality Search query in the localitySearcher.yml as new entry. Add RoleAction Test and Role Action for the URL “/egov-searcher/locality/bpa-services/_get“

Database Schema

Open

Postman Links

Postman Collection

Workflow Configuration

BPA - Building Plan Approval Apply High/Medium Risk

BPA Low – Building Plan Approval Apply Low Risk

BPA OC - Building Plan Approval Occupancy Certificate Apply

BPA and BPA OC Workflow Stages

BPA workflow configuration is for Building Plan Approval Apply High and Medium Risk Types.

BPA OC workflow configuration is for Building Plan Approval Occupancy Certificate irrespective of RiskTypes

Both the workflow flows as depicted below

Open

In the above Flow Chart

• Rectangle Indicates the Workflow State

• Line connecting two states indicates the action

  • Action name is in black color text

  • User Role who can take action is in Blue color Text

Specific Configurations and How To’s

• System allows to configure the Documents that can be visible, allowed to upload and Mandatory to move from the current state in DocumentTypeMapping MDMS as described in MDMS Details Table DocumentTypeMapping Row

• Application Creation Sage

  • Process

    • DCR system is integrated to get the applicationType, serviceType and riskType based on the EDCR Number populated by the architect.

    • DCR system is integrated to validate the status of the EDCRNumber populated

    • New BPA or BPAOC application cannot be created if there is existing un ended( application status other than approved or rejected is considered as un ended) application with the same EDCR

  • How To add new Document

    • Should add new documentType group in DocumentTypeMapping MDMS with the applicable applicationType, serviceType, riskType, wfState (refere existing sample for understanding)

    • Can configure allow, required as well as order for each documentType

    • Make sure the new documentType added exists in documentType of common-masters

• Initiated Stage

  • Process

    • NOC’s from the NocTypeMapping MDMS matching to the application data will get created

  • How To add new NocType

    • Should add new NOCType in NocTypeMapping MDMS

    • New NocType should add in noc-services applicatin as well

• Citizen Approval Pending Stage

  • Process

    • According the example in the NocTypeMapping Data in the MDMS Details Table, Once BPA or BPA OC reaches this Staus all the Applicable Noc’s workflow would be initiated.

  • How to change NOC workflow initiation step

    • Should change the nocTriggerState in NocTypeMapping to the desired application status.

• InProgress Stage

  • Process

    • Application fee Demand gets generated by the bpa-calculator

    • Notification to the Stakeholder and owner will be sent regarding the fee payment

  • How To change the Fee Amount

    • Will be discussed in bpa-calculator service

• Document Verification Pending Stage

  • Process

    • Nothing Specific

  • How To

    • NA

• FieldInspection Pending Stage

  • Process

    • At this stage FieldInspector should answers the checklist questions and attached the documents which will be configured in checklist MDMS, as described in MDMS Details Table CheckList Row

    • Field Inspector can create multiple FieldInspection Reports

  • How to add new questions and documents

    • Should add/modify the questions for the desired combination of applicationType, serviceType, risktype

    • with the localization code for question text

    • specify the fieldType ( ass of now only YES/NO/NA only supported )

    • Should add/modify documents for the desired combination of applicationType, serviceType, risktype

• Noc Verification Pending State

  • Process

    • NOC verifier can upload the Documents to the NOC application’s if available.

    • Offline Noc’s would get autoapproved while NOC verifier is forwarding the BPA or BPAOC application from the current state

    • BPA or BPAOC application cannot be forwarded if any NOC is not in matching the status configured for validate.required.nocs.statuses in application.properties

  • How to change the NOC application status to be verified to move forward

    • should update the validate.required.nocs.statuses property in value in application.properties with the list of status to be considered to move forward

• Approval Pending Stage

  • Process

    • Approver can select the predefined conditions for approval updated in CheckList MDMS, as described in MDMS Details Table checkList Row

    • Approver can add new conditions as well for approval

    • Sanction fee Demand gets generated by the bpa-calculator

    • Notification to the Stakeholder and owner will be sent regarding the fee payment

  • How to add/remove/modify conditions

    • Should add/modify the conditions array for the desired combination of applicationType, serviceType, riskType

• Approved Stage

  • Process

    • System generates PermitOrder for the application

    • System Stamps the validate date for the permit Order by adding the no of months configured for the property egov.bpa.validity.date.in.months in application.properties

  • How to change the valdity period of the permit order which will generate from now

    • Change the value of the property egov.bpa.validity.date.in.months in application.properties file to the desired no of months

  • How to change Permit Order

    • Can be changed by changing the data and format configs of the permit order , please refer PDF’s section of Permit Order

• Rejected Stage

  • Process

    • NA

BPA LOW Workflow

BPA with riskType low has separate workflow, which is almost same with the BPA workflow as depicted below

In the above Flow Chart

• Rectangle Indicates the Workflow State

• Line connecting two states indicates the action

  • Action name is in black color text

  • User Role who can take action is in Blue color Text

Specific Configurations and How To’s which are not common to BPA Workflow

• InProgress Stage

  • Process

    • Application and Sanction Fee together gets calcualted and Demand gets generated by the bpa-calculator

    • Notification to the Stakeholder and owner will be sent regarding the fee payment

  • How To change the Fee Amount

    • Will be discussed in bpa-calculator service

• Document Verification Pending Stage

  • Process

    • System generates PermitOrder for the application

    • System Stamps the validate date for the permit Order by adding the no of months configured for the property egov.bpa.validity.date.in.months in application.properties

  • How to change the valdity period of the permit order which will generate from now

    • Change the value of the property egov.bpa.validity.date.in.months in application.properties file to the desired no of months

• Approved Stage

  • Process

    • NA

• Revocated Stage

  • Process

    • System generates Revocation letter

  • How to change Revocation Letter format

    • Can be changed by changing the data and format configs of the revocation letter , please refer PDF’s section of Revocation letter

Validations included

• On Workflow action of Every Stage, System verifies the Documents Configured for the given stage of the workflow from the DocumentTypeMapping MDMS and validates the required Documents attached to move forward

• DropDown values to be validate against the MDMS values, Value in those field should be one of the MDMS value.

Notifications

Notifications Message codes for SMS and User Events are prepared as follows

ApplicationType_ServiceType_WorkflowAction_ApplicationStatus.

Example BPA Apply Application (i.e applicationType is BUILDING_PLAN_SCRUTINY) with ServiceType NEW_CONSTRUCTION and the current application status is DOCUMENT_VERIFICATION_PENDING and workflow Action of the request is FORWARD then the localized message for this notification will be looked for the code: BUILDING_PLAN_SCRUTINY_NEW_CONSTRUCTION_FORWARD_DOCUMENT_VERIFICATION_PENDING

The message text for the above code is sent through SMS and Notification filling the owner, serviceType, application Number and other values.

PDFS used

BPA supports below PDF’s