Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. To add a new report first add the file path in the reportFileLocationsv1.
    The W&S report location can be listed as in the following link: https://github.com/egovernments/configs/blob/f80f822314ef951890b41c92ca9eab3ee41413b0/reports/reportFileLocationsv1.txt#L21

  2. Once file path is added in the file reportFileLocationsv1, go to the folder /configs/reports/config [https://github.com/egovernments/configs/tree/qa/reports/config ] .
    Create a new file and name the file what you have given in file reportFileLocationsv1.
    For W&S report we can name it as : rainmaker-wns-reports.yml

  3. Write the report configuration.
    Refer https://github.com/egovernments/configs/blob/qa/reports/config/rainmaker-wns-reports.yml for current configs.
    [For further clarification on how to write the report configs, refer : Report Service ]
    Once it is done commit those changes.

  4. Add the role and actions for the new report as follows:

    In action-test.json:

    Code Block
    {
          "id": 2343,
          "name": "WnsDefaulterReport",
          "url": "url",
          "displayName": "WnS Defaulter Report",
          "orderNumber": 2,
          "parentModule": "rainmaker-wns",
          "enabled": true,
          "serviceCode": "WnS",
          "code": "null",
          "path": "WnS.Wns Reports.WnSDefaulterReport",
          "navigationURL": "report/rainmaker-wns/WnsDefaulterReport",
          "leftIcon": "action:assignment",
          "rightIcon": ""
        },
        {
          "id": 2344,
          "name": "WnsDefaulterReport",
          "url": "/report/rainmaker-wns/WnsDefaulterReport/metadata/_get",
          "displayName": "rainmaker-wns-WnsDefaulterReport",
          "orderNumber": 1,
          "parentModule": "",
          "enabled": true,
          "serviceCode": "report",
          "code": "null",
          "path": ""
        },
        {
          "id": 2345,
          "name": "WnsDefaulterReport",
          "url": "/report/rainmaker-wns/WnsDefaulterReport/_get",
          "displayName": "rainmaker-wns-WnsDefaulterReport",
          "orderNumber": 1,
          "parentModule": "",
          "enabled": true,
          "serviceCode": "report",
          "code": "null",
          "path": ""
        }


    In action-test.json:

    Code Block
        {
          "rolecode": "WATER_REPORT_VIEWER",
          "actionid": 2343,
          "actioncode": "",
          "tenantId": "pb"
        },
        {
          "rolecode": "SEWERAGE_REPORT_VIEWER",
          "actionid": 2343,
          "actioncode": "",
          "tenantId": "pb"
        },
        {
          "rolecode": "WATER_REPORT_VIEWER",
          "actionid": 2344,
          "actioncode": "",
          "tenantId": "pb"
        },
        {
          "rolecode": "SEWERAGE_REPORT_VIEWER",
          "actionid": 2344,
          "actioncode": "",
          "tenantId": "pb"
        },
        {
          "rolecode": "WATER_REPORT_VIEWER",
          "actionid": 2345,
          "actioncode": "",
          "tenantId": "pb"
        },
        {
          "rolecode": "SEWERAGE_REPORT_VIEWER",
          "actionid": 2345,
          "actioncode": "",
          "tenantId": "pb"
        }

  5. Restart the MDMS and report service.

Info

Above is the sample for Defaulter Report, in similar way other reports can also be configured.

Reference Docs

...