Overview

Trade License Calculator service is used to calculate the Trade license fees / renewal fees based on the defined billing slabs. This service enables the TL admins to create billing slab with different combination of license type, trade type, structure type and accessory type. The service is designed in such a way that it can be used to serve different type of licenses.

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

• Java 8

• Kafka server is up and running

• egov-persister service is running and has tl-calculation-persister & tl-billing-slab-persister config path added in it

• PSQL server is running and a database is created to store TL Application data

• Following services should be up and running:

  • egov-perister

  • egov-mdms

  • tl-services

  • billing-service

Key Functionalities

• TL Admin an Employee of ULB with TL_Admin role can create, update billing slab(s)

• ULB Employee with TL_CREATOR and TL_ADMIN can search billing slab(s)

• TL service internally calls tl-calculator to generate demand.

Deployment Details

1. Deploy the latest version of tl-service and tl-calculator

2. Add tl-calculation-persister.yml & tl-billing-slab-persister.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

MDMS for Penalty Calculation

{
  "tenantId": "pb",
  "moduleName": "TradeLicense",
  "Penalty": [
    {
      "rate": 10,
      "minAmount": 0.0,
      "flatAmount": 0.0,
      "fromFY": "2018-19",
      "startingDay": "1/09/2018"
    },
    {
      "rate": 10,
      "minAmount": 0.0,
      "flatAmount": 0.0,
      "fromFY": "2015-16",
      "startingDay": "1/04/2016"

    }
  ]
}   

MDMS file for Rebate Calculation

{
  "tenantId": "pb",
  "moduleName": "TradeLicense",
  "Rebate": [
    {
      "rate": 10,
      "maxAmount": null,
      "flatAmount": 0.0,
      "fromFY": "2018-19",
      "endingDay": "31/03"

    },
    {
      "rate": 10,
      "maxAmount": null,
      "flatAmount": 0.0,
      "fromFY": "2019-20",
      "endingDay": "31/03"
    }
  ]  
}

Actions & Role Action Mapping

Actions

[
  {
    "id": {{PLACEHOLDER1}},
    "name": "TL BillingSlab Create",
    "url": "/tl-calculator/billingslab/_create",
    "displayName": "TL BillingSlab Create",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER2}},
    "name": "TL BillingSlab Update",
    "url": "/tl-calculator/billingslab/_update",
    "displayName": "TL BillingSlab Update",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER3}},
    "name": "TL BillingSlab Search",
    "url": "/tl-calculator/billingslab/_search",
    "displayName": "TL BillingSlab Search",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER4}},
    "name": "TL Calculation",
    "url": "/tl-calculator/v1/_calculate",
    "displayName": "TL Calculation",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  }
]

Role Action Mapping

[
  {
    "rolecode": "TL_ADMIN",
    "actionid": "{{PLACEHOLDER1}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "TL_ADMIN",
    "actionid": "{{PLACEHOLDER2}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "TL_CREATOR",
    "actionid": "{{PLACEHOLDER3}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "TL_CEMP",
    "actionid": "{{PLACEHOLDER3}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "TL_CEMP",
    "actionid": "{{PLACEHOLDER4}}",
    "actioncode": "",
    "tenantId": "pb"
  }
]

Integration Details

Integration Scope

tl-calculator will be integrated with tl-services. tl-services internally invoke the tl-calculator service to calculate and generate demand for the charges.

Integration Benefits

Tl calculator application is used to calculate the Trade license Fees based on the different billing slabs in the DB that's why the calculation and demand generation logic will be separated out from TL services. So in future, if calculation logic needs to modify then changes can be carried out for each implementation without modifying the TL services.

Steps to Integration

1. TL application to call /tl-calculator/v1/_calculate to calculate and generate the demand for the TL application

2. ULB Employee can create billing slab calling /tl-calculator/billingslab/_create

3. ULB Employee can update billing slab calling /tl-calculator/billingslab/_update

4. ULB Employee can search billing slab calling /tl-calculator/billingslab/_search

Interaction Diagram

TBD

Reference Docs

Doc Links

API List

(Note: All the API’s are in the same postman collection therefore the same link is added in each row)

__

__

Overview

This service is used to issue a license to the user after verification. The service is designed in such a way that it can be used to serve different type of licenses. Currently used to issue trade licenses, perform stakeholder registration and issue lockdown pass. The service is integrated with workflow where we can define the steps for approval of the application. Once the application is approved the license is generated.

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 tl-services persister config path added in it

• PSQL server is running and database is created

Key Functionalities

• Used for license generations in trade licenses, stakeholder registration and issue lockdown pass

• Define roles to applicants on successful application to access Building Plan Approval services at the time of stakeholder registration

• Generate application number and license number

• Support workflows

• Provide notification on various status changes for an application

Interaction Diagram

Deployment Details

1. Add MDMS configs required for Trade License and BPA stakeholder registration and restart MDMS service

2. Deploy the latest version of tl-services service

3. Add tl-service persister yaml path in persister configuration and restart persister service

4. Add Role-Action mapping for API’s

5. Create businessService (workflow configuration) according to trade license and stakeholder registration

6. Add tl-service indexer yaml path in indexer service configuration and restart indexer service

Configuration Details

Following application properties in the Trade License service are configurable.

Integration

Integration Scope

The trade-license service is currently used to issue trade licenses, perform stakeholder registration and issue lockdown pass.

Integration Benefits

• Provide backend support for the different license registration process.

• Mseva and SMS notifications on application status changes.

• The elastic search index for creating visualizations and Dashboards.

• Bpa Stakeholder registration provides new roles to the user to access the Building Plan Approval system.

• Supports workflow which is configurable

Steps to Integration

1. To integrate, host of tl-services service should be overwritten in the helm chart.

2. {servicename}/_create/ _create should be added as the create endpoint for creating any license in the system

3. {servicename}/_search/ _search should be added as the search endpoint. This method handles all requests to search existing records depending on different search criteria

4. {servicename}/_update/ _update should be added as the update endpoint. This method is used to update fields in existing records or to update the status of the application based on workflow.

Reference Docs

Doc Links

API List

In all below endpoints if the service name is BPAREG it is treated as a stakeholder registration application and if it is TL or if it is absent then the application is treated as trade license application.

Stakeholder registration APIs:- https://www.getpostman.com/collections/d18b79ccfb69ee8bb526

Trade-License APIs:- https://www.getpostman.com/collections/99f98723c45f97024831