TL Renewal Technical Documentation

Migration:

Two new columns added for TL Renewal flow. applicationType and workflowCode. To deploy TL Renewal in environment where TL is already running , these 2 columns needs to be migrated to eg_tl_tradelicense and eg_tl_tradelicense_audit table. The following query does this migration:

Configurations:

Persister:

Persister config for TL Renewal is updated. Insert query for the table eg_tl_tradelicense is added in tradelicense.yml . The latest updated config can be referred from the below link:

https://github.com/egovernments/configs/blob/master/egov-persister/tradelicense.yml

BusinessService:

For renewal application , there are 2 new types. 'Edit Renewal' and 'Direct Renewal' . Edit (EDITRENEWAL) flow will follow the same workflow as normal Trade License. Direct (DIRECTRENEWAL) Renewal will follow a new workflow.

Hence 2 new Business service configs are pushed for each flow respectively.

EDITRENEWAL : <domain>/egov-workflow-v2/egov-wf/businessservice/_search?tenantId=pb.amritsar&businessServices=EDITRENEWAL

DIRECTRENEWAL : <domain>/egov-workflow-v2/egov-wf/businessservice/_search?tenantId=pb.amritsar&businessServices=DIRECTRENEWAL

mdms:

https://raw.githubusercontent.com/egovernments/egov-mdms-data/master/data/pb/BillingService/BusinessService.json

{
      "businessService": "TL.RENEWAL",
      "code": "TL.RENEWAL",
      "collectionModesNotAllowed": [
        "DD"
      ],
      "partPaymentAllowed": false,
      "isAdvanceAllowed": false,
      "isVoucherCreationEnabled": true,
      "isActive": true
    },

https://raw.githubusercontent.com/egovernments/egov-mdms-data/master/data/pb/BillingService/TaxHeadMaster.json

{
      "category": "FEE",
      "service": "TL",
      "name": "TL Renewal Tax",
      "code": "TL_RENEWAL_TAX",
      "isDebit": false,
      "isActualDemand": true,
      "order": "2",
      "isRequired": false
    },
    {
      "category": "REBATE",
      "service": "TL",
      "name": "TL Renewal Rebate",
      "code": "TL_RENEWAL_REBATE",
      "isDebit": true,
      "isActualDemand": false,
      "order": "0",
      "isRequired": false
    },
    {
      "category": "PENALTY",
      "service": "TL",
      "name": "TL Renewal Penalty",
      "code": "TL_RENEWAL_PENALTY",
      "isDebit": false,
      "isActualDemand": false,
      "order": "1",
      "isRequired": false
    },
    {
      "category": "TAX",
      "service": "TL",
      "name": "TL Renewal adhoc rebate",
      "code": "TL_RENEWAL_ADHOC_REBATE",
      "isDebit": true,
      "isActualDemand": false,
      "order": "0",
      "isRequired": false
    },
    {
      "category": "TAX",
      "service": "TL",
      "name": "TL Renewal adhoc penalty",
      "code": "TL_RENEWAL_ADHOC_PENALTY",
      "isDebit": false,
      "isActualDemand": false,
      "order": "1",
      "isRequired": false
    }

https://raw.githubusercontent.com/egovernments/egov-mdms-data/master/data/pb/BillingService/TaxPeriod.json

 {
      "fromDate": 1585679399000,
      "toDate": 1617172199000,
      "periodCycle": "ANNUAL",
      "service": "TL",
      "code": "TLRENEWAL2020",
      "financialYear": "2020-21"
    },

https://raw.githubusercontent.com/egovernments/egov-mdms-data/master/data/pb/egf-master/FinancialYear.json

{
      "id": "7",
      "tenantId": "pb",
      "finYearRange": "2020-21",
      "name": "2020-21",
      "code": "2020-21",
      "startingDate": 1585679399000,
      "endingDate": 1617172199000,
      "active": true,
      "isActiveForPosting": false,
      "isClosed": false,
      "transferClosingBalance": false,
      "module": "TL"
    },

application.properties :

EDITRENEWAL & DIRECTRENEWAL businessService codes are added.

create.directRenewal.workflow.name=DIRECTRENEWAL
create.editRenewal.workflow.name=EDITRENEWAL

TradelicenseSearcCriteria.java

licenseNumber variable is now list if String. Hence licenseNumber is replaced everywhere with licenseNumbers

@JsonProperty("licenseNumbers")
private List<String> licenseNumbers;

TLQueryBuilder.java

List<String> licenseNumbers = criteria.getLicenseNumbers();
if (!CollectionUtils.isEmpty(licenseNumbers)) {
    addClauseIfRequired(preparedStmtList, builder);
    builder.append(" tl.licensenumber IN (").append(createQuery(licenseNumbers)).append(")");
    addToPreparedStatement(preparedStmtList, licenseNumbers);
}

Frontend:

All APPROVED and EXPIRED applications are configured with 2 buttons ‘EDIT FOR RENEWAL' and 'SUBMIT FOR RENEWAL’ .

Edit for Renewal : Will be redirected to edit flow , where Citizen/ Counter employee have acces to change specific fields. New set of documents can be updated for Renewal flow, which is configured in mdms.

Documents Configuration :

https://github.com/egovernments/egov-mdms-data/blob/master/data/pb/TradeLicense/TradeType.json

License Number will be shown in the header.

Direct Renewal : Will be applied directly for Renewal. Which send application to PENDINGPAYMENT status.
SUBMIT FOR RENEWAL- Directly Submitted without editing.

TL Certificate configuration :

https://github.com/egovernments/configs/blob/master/pdf-service/data-config/tlrenewalcertificate.json - Data Config

https://github.com/egovernments/configs/blob/master/pdf-service/format-config/tlrenewalcertificate.json - Format Config

Employee :

Search Screen :

'Application Type' search param added.

Search Results have 2 more columns now.

Financial Year and Application Type :

CITIZEN:

On approved application RENEWAL BUTTON is vible to citizen.