Common pay configuration

Mdms Configuration

https://github.com/egovernments/egov-mdms-data/blob/master/data/pb/common-masters/uiCommonPay.json

https://github.com/egovernments/egov-mdms-data/blob/master/data/pb/BillingService/BusinessService.json

{
    arrears: true
    billKey: "property-bill"
    cancelReceipt: true
    code: "PT"
    headerBandLabel: "PT_COMMON_TABLE_COL_PT_ID"
    pdfModule: "PT"
    receiptKey: "property-receipt"
      "buttons": [
        {
          "label": "COMMON_BUTTON_HOME",
          "citizenUrl": "/property-tax",
          "employeeUrl": "/pt-mutation/propertySearch"
        }
      ]
    },

The above json has each object for every BusinessService like PT, TL . When a new module is integrated a new object should be added in above json file.

Taking a example of PT - There are 2 pages in common-pay mocule.

egov-common/pay :

• Header Band - Configured from mdms (headerBandLabel)

• Fee Details - Fetched from fetchBill Response

• Capture Payment - Tabs are configured from BusinessService.json with "collectionModesNotAllowed" property.

{
      "businessService": "PropertyTax",
      "code": "PT",
      "collectionModesNotAllowed": [
        "DD"
      ],
      "partPaymentAllowed": true,
      "minAmountPayable":100,
      "isAdvanceAllowed": false,
      "demandUpdateTime": 86400000,
      "isVoucherCreationEnabled": true,
      "billGineiURL" : "egov-searcher/bill-genie/billswithaddranduser/_get"
    }

• Amount to be Paid - Configured from BusinessService.json with "partPaymentAllowed" property.

• Partial Amount - Configured from BusinessService.json with "minAmountPayable" property.

• G8 Receipt Details - Appears for all Modules

egov-common/acknowledgement :

• Header Band - Configured from mdms (headerBandLabel)

• The messages displayed on the acknowledgement page are configured both for success and failure cases.

PDF Configurations :

Different configurations are written for every Modules Receipt and Bills

Example :

PT Receipt data Config : https://github.com/egovernments/configs/blob/master/pdf-service/data-config/property-receipt.json

PT Receipt format Config : https://github.com/egovernments/configs/blob/master/pdf-service/format-config/property-receipt.json

TL Receipt data-config : https://github.com/egovernments/configs/blob/master/pdf-service/data-config/tradelicense-receipt.json

TL Receipt format-config : https://github.com/egovernments/configs/blob/master/pdf-service/format-config/tradelicense-receipt.json

When a new module is integrated then new configurations for both BIll and Receipts should be written in the below path :

https://github.com/egovernments/configs/tree/master/pdf-service

Enabling state level configuration :

https://github.com/egovernments/egov-mdms-data/blob/master/master-config.json

"uiCommonPay": {
      "masterName": "uiCommonPay",
      "isStateLevel": true,
      "uniqueKeys": []
    }

statelevel configuration is added for newly added json.

UI Changes :

All downloadReceipt and downloadBill functions are refactored. So all module developers will have to update the calls respectively in the module screens .

download(receiptQueryString , "download"); is changed to download(receiptQueryString , "download" , receiptKey); - receiptKey specific to each modules is added as a 3rd param

download(receiptQueryString ,"print"); is changed to download(receiptQueryString ,"print" , receiptKey ,state); - receiptKey specific to each modules is added as a 3rd param

If configs are not added in mdms for any module then it fetches default keys :

Bill data-config - https://github.com/egovernments/configs/blob/master/pdf-service/data-config/consolidatedbill.json

Bill format config - https://github.com/egovernments/configs/blob/master/pdf-service/format-config/consolidatedbill.json

Receipt data-config - https://github.com/egovernments/configs/blob/master/pdf-service/data-config/consolidatedreceipt.json

Receipt format-config - https://github.com/egovernments/configs/blob/master/pdf-service/format-config/consolidatedreceipt.json

Mdms Configuration :

{
      "businessService": "PropertyTax",
      "code": "PT",
      "collectionModesNotAllowed": [
        "DD","OFFLINE_NEFT","OFFLINE_RTGS","POSTAL_ORDER"
      ],
      "partPaymentAllowed": true,
      "minAmountPayable":100,
      "isAdvanceAllowed": false,
      "demandUpdateTime": 86400000,
      "isVoucherCreationEnabled": true,
      "billGineiURL" : "egov-searcher/bill-genie/billswithaddranduser/_get"
    },

Configure those instrument types in "collectionModesNotAllowed" field to not appear in common pay screen.

Arrears Details configuration(from Release V2.4)

In the uiCommonPay Config based on the flag arrears Bill details shows Arrears Details card ,

which has a Details about arrears with respect to each financial years. If Arrears is required from the specific business service then it has to updated to see the Arrears card

arrears: true
billKey: "property-bill"
buttons: [,…]
cancelReceipt: true
code: "PT"
headerBandLabel: "PT_COMMON_TABLE_COL_PT_ID"
pdfModule: "PT"
receiptKey: "property-receipt"

Arrears details will be displayed as below

Localisation

Please add localisation keys in the below sheet:

https://docs.google.com/spreadsheets/d/1KpYzXFqDz4MjJZFDFTtn8PC1ik8aOzoYbY7h34gvgxg/edit#gid=0

API Call Role Action mapping: