For enabling any municipal-service on a fresh environment and for the first time, we need to have basic idea of what DIGIT does and what all generic services are required for setting it up .

DIGIT is an open-source, customizable platform that lends itself to extensibility. New modules can be built on top of the platform to suit new use-cases or existing modules can be modified or replaced. To enable this, in addition to deploying DIGIT, a CD/CI pipeline should be set up. CD/CI pipelines enable the end user to automate & simplify the build/deploy process.

Refer here for further reference of DIGIT and its deployment.

Core Services:

DIGIT platform comprises of couple of core-services that serves as the backbone for the platform. There are several core-services like:

1. Workflow Service

2. Location Service

3. User Service

4. Access Control Service

5. PDF Service

6. Payment Service

7. MDMS Service

8. Indexer Service

9. Persister Service

10. ..and many more

Each microservice has a distinct function, which is explained in the provided documentation links. Once you understand the platform and its terminology, you'll be well-prepared to activate any particular municipal service.

This document shows the preparation of the mdms changes be to done for data loading.

1. To add data in tenant/tenants.json - For showing the tenant at login screen Sample Data :

Example : Create a json for new ulb and Add required details given.

{
    "code": "od.angul",
    "name": "Angul",
    "description": "Angul",
    "logoId": "https://digitaldesksujog051120.blob.core.windows.net/assets/Logos/odlogo.png",
    "imageId": null,
    "domainUrl": "https://sujog.odisha.gov.in",
    "type": "CITY",
    "twitterUrl": null,
    "facebookUrl": null,
    "emailId": "angulmunicipality@gmail.com",
    "OfficeTimings": {
        "Mon - Fri": "9.00 AM - 6.00 PM",
        "Sat": "9.00 AM - 12.00 PM"
    },
    "pincode": [
        759122,
        759132,
        759123,
        759143
    ],
    "city": {
        "name": "Angul",
        "localName": null,
        "districtCode": "Angul",
        "districtName": "Angul",
        "regionName": "Angul",
        "ulbGrade": "Angul Municipality",
        "longitude": 0,
        "latitude": 0,
        "shapeFileLocation": null,
        "captcha": null,
        "code": "ANG",
        "ddrName": "Angul",
        "wsBillHeaderLine1": "OFFICE OF THE AE/JE",
        "wsBillHeaderLine2": "PUBLIC HEALTH ENGINEERING ORGANIZATION : Angul",
        "districtTenantCode": "od.angul"
    },
    "address": "AT/PO-Amlapada,Dist-Angul, Pin-759122",
    "contactNumber": "",
    "helpLineNumber": "14420"
}

1. Adding in tenant/citymodule.json - To enable ulb to create application,add new tenant code in FSM module.

   Copy

   {
       "module": "FSM",
       "code": "FSM",
       "active": true,
       "tenants": [
           {
               "code": "pg.citya"
           },
           {
               "code": "pg.angul"
           }
       ]
   }

2. Adding FSTP details in FSM/FSTPPlantInfo.json Required Details:

Eg.

{
    "PlantCode": "ANG_001",
    "PlantName": "ANGUL Plant",
    "active": true,
    "PlantType": "SeTP",
    "PlantLocation": "ANGUL",
    "PlusCode": "R3RW+7JQ",
    "PlantOperationalTimings": "09.00am-05.00pm",
    "PlantOperationalCapacityKLD": "18",
    "ULBS": "pg.angul"
}

• Creating Boundary data for Gram Panchayat in ULBNAME/egov-location/boundary-data.json The GP details will be given in Annexure-5,in hierarchyType - REVENUE ,add GP data after locality data. The json format of GP is :

  Copy

  {
      "id": 6,
      "boundaryNum": 1,
      "name": "GP 1",
      "localname": "GP1",
      "longitude": null,
      "latitude": null,
      "label": "GP",
      "code": "GP1",
      "children": [
          {
              "id": 11,
              "boundaryNum": 1,
              "name": "Village 1",
              "localname": "Village local 1",
              "longitude": 74.871552,
              "latitude": 31.63089,
              "label": "Village",
              "code": "VIL1",
              "pincode": [
                  143001
              ],
              "area": "V-Area1",
              "children": []
          },
          {
              "id": 12,
              "boundaryNum": 1,
              "name": "Village 2",
              "localname": "Village local 2",
              "longitude": null,
              "latitude": null,
              "label": "Village",
              "code": "VIL2",
              "pincode": [
                  143001
              ],
              "area": "V-Area1",
              "children": []
          }
      ]
  },

Example:

{
    "tenantId": "pg.rourkela",
    "moduleName": "egov-location",
    "TenantBoundary": [
        {
            "hierarchyType": {
                "code": "REVENUE",
                "name": "REVENUE"
            },
            "boundary": {
                "id": 1,
                "boundaryNum": 1,
                "name": "Rourkela",
                "localname": "Rourkela",
                "longitude": null,
                "latitude": null,
                "label": "City",
                "code": "pg.rourkela",
                "children": [
                    {
                        "id": "2",
                        "boundaryNum": 1,
                        "name": "Pradhanpalli",
                        "localname": "Pradhanpalli",
                        "longitude": null,
                        "latitude": null,
                        "label": "Locality",
                        "code": "VIL1"
                    },
                    {
                        "id": "3",
                        "boundaryNum": 1,
                        "name": "Other",
                        "localname": "Other",
                        "longitude": null,
                        "latitude": null,
                        "label": "GP",
                        "code": "OTH1",
                        "children": []
                    }
                ]
            }
        }
    ]
}

Steps to create the jsons of GP data -

• The GP data is given in excel format.

• Copy all the GP’s list and make an excel with format given below

• The name and localname is the GP name provided

• The label is always GP and boundaryNum is 1.

• Id is unique for each GP and should be in sequential order.

• Provide a proper format of GP code according to GPname.

• Convert the excel data into json using excel-json online converter.

• Add the GP data after locality data in boundary-data.json file .

• Check the format once,change id into string if it is in integer format.

• Add "children": [] for each GP separately after converting to json.

1. Adding Slum Details in ULBNAME/FSM/Slum.json The name of the slums will be provided.The format of slum adding in mdms is:

   Copy

   {
       "name": "slumname",
       "active": true,
       "code": "CODE001",
       "locality": "VIL1"
   }

Steps To Create the jsons of Slum data : The slum data is provided in excel format.

• Make an excel with with given format

• Add all the slums in name field

• change the code according to ulb name

• add locality VIL1 according to boundary-data.

• convert the excel data into json using excel to json converter.

• create a folder of a respective tenant and inside it add slum.json file in FSM folder.

1. Adding New Vehicles in VehicleMakeModel Before pushing the vehicle data,new vehicle should be added in mdms.

Eg. new vehicle add

{
    "code": "MAHINDRA",
    "name": "Mahindra",
    "active": true
},
{
    "code": "MAHINDRA.TRUCK",
    "name": "Truck",
    "active": true,
    "make": "MAHINDRA",
    "capacity": "1000"
}

The code should be different for each vehicle and in format make.name .

1. Billing-slab pricing preparation For adding the rate slabs(pricing) of vehicles,consider different combination of propertyType , slum and tank capacity.

   1. Required combination of property types and Sub-property types added in MDMS :

   2. RESIDENTIAL and RESIDENTIAL.SUB-PROPERTY_TYPE

   3. INSTITUTIONAL and INSTITUTIONAL.SUB-PROPERTY_TYPE

   4. COMMERCIAL and COMMERCIAL.SUB-PROPERTY_TYPE

   5. Sample Data for pricing :

Steps to make billing-slab data: A. Create an excel file in given format

B. Consider all property types and sub-property type present in mdms with slum YES and with slum NO.

C. for capacity 1000L,the pricing is given as

For slum NO :

1. RESIDENTIAL and RESIDENTIAL.SUB-PROPERTY_TYPE - 1000

2. INSTITUTIONAL and INSTITUTIONAL.SUB-PROPERTY_TYPE - 1000

3. COMMERCIAL and COMMERCIAL.SUB-PROPERTY_TYPE - 1000

For slum YES(Per trip Pricing for Slum areas) :

1. RESIDENTIAL and RESIDENTIAL.SUB-PROPERTY_TYPE - 800

2. INSTITUTIONAL and INSTITUTIONAL.SUB-PROPERTY_TYPE - 800

3. COMMERCIAL and COMMERCIAL.SUB-PROPERTY_TYPE - 800

D. for capacity 3000L,the pricing is given as

For slum NO :

1. RESIDENTIAL and RESIDENTIAL.SUB-PROPERTY_TYPE - 2000

2. INSTITUTIONAL and INSTITUTIONAL.SUB-PROPERTY_TYPE - 2000

3. COMMERCIAL and COMMERCIAL.SUB-PROPERTY_TYPE - 3000

For slum YES(Per trip Pricing for Slum areas) :

1. RESIDENTIAL and RESIDENTIAL.SUB-PROPERTY_TYPE - 1500

2. INSTITUTIONAL and INSTITUTIONAL.SUB-PROPERTY_TYPE - 1500

3. COMMERCIAL and COMMERCIAL.SUB-PROPERTY_TYPE - 1500

E. After creating the excel file by considering the combinations,convert the excel file into json.

F. Push the same json file in billing slab api using runner.

List of actions required to go live in the new State for the FSM module:

• Getting started with DIGIT

• Requirements to enable FSM Module in a new environment

• Dependency services of the FSM module

• Data templates for data collection

• Data loading steps: Tenant, boundary, workflow etc

• MDMS data : Mdms data and preparation

• SMS Templates and their registrations/loading

To enable FSM module in any new environment, we would need to perform certain steps. Considering an AWS account is already setup, following are the steps to be followed:

Configuration Requirements

1. Update the Configs repo with the following requirements:

   • Indexer config: We will need following indexer files for setting up any module FSM indexer Vehicle indexer Vendor indexer Demand/billing indexer Payment indexer

   • Persister config Persister files required: Apportion persister Billing-service persister Workflow persister HRMS persister Filestore persister PDF gen persister Pg-service persister Upload persister egov-user-event-persister FSM persister FSM Calculator persister Vehicle persister Vendor persister

   • Searcher config FSM searcher

   • Pdf config Data config: fsm-receipt Format config: fsm-receipt

   • Reports fsm-report Also mention the path of the above report file here.

   • Dashboard configs => ChartApiConfig.json => MasterDashboardConfig.json

2. Add all mdms configs required

   • Add all Actions/endpoints required for fsm as mentioned in this file. Add all actions with respect to core and business-services as well, like those of - egov-user, egov-mdms-service, apportion-service, collection-service, billing-service, egov-location, egov-common-masters, egov-idgen, egf-master, egov-user-event, otp services, access, egov-workflow-v2, data-uploader, egov-hrms, filestore-service, pdf-service, egov-pdf, report, localization-service, egov-persister, egov-indexer, egov-searcher, eg-pg-service, dasboard-analytics, dashboard-ingest, digit-ui, fsm, fsm-calculator, vendor, vehicle.

   • Add Role-Action mapping in roleactions.json file

   • Add required Roles for the respective FSM module in roles.json

   • Add BillingService, DIGIT-UI, DataSecurity, FSM, Vehicle, Vendor, Workflow, common-masters, dss-dashboard, egf-master, egov-hrms , tenant folders with their respective files.

   • Also add ULB/city specific data in their respective folders, for instance, create a folder angul and add the respective data files like Slum.json, UrcConfig.json, ZeroPricing.json required.

Note: The data sepecific to any ULB needs to be collected from the ULB officials and need to be present in mdms level. Refer the ULB specific data documentation and updation/upsertion here.

DevOps Requirements

1. Add all the helm charts with respect to the business-services, core-services and municipal-services. Refer here.

2. Add DevOps level changes in the evironment file. Refer here. Add all the paths for files in the configs in the environment file. For instance, add the the path of indexer, persister and searcher files, etc. Make sure to add required properties at each service level as defined in the above mentioned environment file.

Backend/Frontend Requirements

1. Deploy all required core-services builds to support this municipal-services(FSM and its dependent services). The core-services include: egov-accesscontrol, egov-common-masters, egov-data-uploader, egov-document-uploader, egov-enc-service, egov-filestore, egov-idgen,egov-indexer, egov-localization, egov-location, egov-mdms-service, egov-notification-mail, egov-notification-sms, egov-otp, egov-persister, egov-pg-service, egov-searcher, egov-url-shortening, egov-user, egov-workflow-v2, pdf-service, report, user-otp, zuul

2. Deploy all required business-services builds to support this municipal-service(FSM and its dependent services). The business-services include: billing-service, collection-services, dashboard-analytics, dashboard-ingest, egf-instrument, egf-master, egov-apportion-service, egov-hrms.

3. Deploy this municipal-service “fsm” as well as dependent municipal-services: fsm-calculator, vendor, vehicle, inbox, egov-user-event.

4. Upsert the required localizations. Refer this document for detailed steps.

5. Upsert the workflows as mentioned in the document.

6. Upsert the SMS templates as localizations in your environment as well as update them in the SMS portal being used by the state. For detailed infomation, read here.

1. FSM Service Faecal sludge management (FSM) is a system that enables citizen to raise a request for septic tank cleaning with there ULB’s directly or indirectly reaching out to ULB counter. Citizen can track the application, make a payment for the charges and rate the service. Actions & Role Action Mapping : Add Role-Action mapping for the API’s in MDMS. Following are the required entries. They should be mapped to both CITIZEN and appropriate employee roles.

• MDMS Actions & Role Action Mapping for FSM

{
    "id": {{PLACEHOLDER1}},
    "name": "Create FSM Application",
    "url": "/fsm/v1/_create",
    "displayName": "Apply FSM",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "FSM",
    "code": "null",
    "path": ""
  },
  {
    "id":  {{PLACEHOLDER2}},
    "name": "Search FSM Application",
    "url": "/fsm/v1/_search",
    "displayName": "Search  FSM Appliacations",
    "orderNumber": 1,
    "enabled": false,
    "serviceCode": "FSM",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER3}},
    "name": "Update FSM Application",
    "url": "/fsm/v1/_update",
    "displayName": "Update FSM",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "FSM",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER4}},
    "name": "FSM Application Charge Payment Search",
    "url": "/collection-services/payments/FSM.TRIP_CHARGES/_search",
    "displayName": "FSM Application Charge Payment Search",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER5}},
    "name": "FSM Application Audit Search",
    "url": "/fsm/v1/_audit",
    "displayName": "FSM Application Audit serach",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  }, 
  {
    "id": {{PLACEHOLDER7}},
    "name": "Create FSTP FSTPOperator Mapping",
    "url": "/fsm/plantmap/v1/_create",
    "displayName": "Create FSTP FSTPOperator Map",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "FSM",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER8}},
    "name": "Update FSTP FSTPOperator Mapping",
    "url": "/fsm/plantmap/v1/_update",
    "displayName": "Update FSTP FSTPOperator Map",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "FSM",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER9}},
    "name": "Search FSTP FSTPOperator Mapping",
    "url": "/fsm/plantmap/v1/_search",
    "displayName": "Search FSTP FSTPOperator Map",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "FSM",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PlaceHolder10}},
    "name": "Inbox Search ofr uI",
    "url": "/inbox/v1/_search",
    "displayName": "Inbox Search",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "inbox",
    "code": "null",
    "path": ""
  }
 

• Role Action Mapping:

API List

1. FSM Calculator Service

• FSM Calculator is a system that enables FSM Admin to create billing slab for the FSM application(s) with different combination of propertyType , slum , tank capacity and etc..

• MDMS Actions & Role Action Mapping for FSM Calculator:

[
      {
        "id": {{PLACEHOLDER1}},
        "name": "FSM BillingSlab Create",
        "url": "/fsm-calculator/v1/billingSlab/_create",
        "displayName": "FSM BillingSlab Create",
        "orderNumber": 1,
        "parentModule": "",
        "enabled": false,
        "serviceCode": "",
        "code": "null",
        "path": ""
      },
      {
        "id": {{PLACEHOLDER2}},
        "name": "FSM BillingSlab Update",
        "url": "/fsm-calculator/v1/billingSlab/_update",
        "displayName": "FSM BillingSlab Update",
        "orderNumber": 1,
        "parentModule": "",
        "enabled": false,
        "serviceCode": "",
        "code": "null",
        "path": ""
      },
      {
        "id": {{PLACEHOLDER3}},
        "name": "FSM BillingSlab Search",
        "url": "/fsm-calculator/v1/billingSlab/_search",
        "displayName": "FSM BillingSlab Search",
        "orderNumber": 1,
        "parentModule": "",
        "enabled": false,
        "serviceCode": "",
        "code": "null",
        "path": ""
      }
    ]

• Role Action Mapping:

API List

1. Vendor Service

Vendor Registry is a system that enables ULBEmployees to create and search Vendor i.e Desluding Operator (DSO) and driver entities with appropriate vehicle Entities for FSM Application. This document contains the details about how to setup the Vendor and describe the functionalities provided.

• MDMS Actions & Role Action Mapping for Vendor

{
      "id": {{PLACEHOLDER1}},
      "name": "Create Vendor/DSO",
      "url": "/vendor/v1/_create",
      "displayName": "Create Vehicle",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "vendor",
      "code": "null",
      "path": ""
},
{
      "id": {{PLACEHOLDER2}},
      "name": "Search Vendor/DSO",
      "url": "/vendor/v1/_search",
      "displayName": "Search  Vendor",
      "orderNumber": 1,
      "enabled": false,
      "serviceCode": "vendor",
      "code": "null",
      "path": ""
},
{
  "id": {{PLACEHOLDER6}},
  "name": "Update Vendor/DSO",
  "url": "/vendor/v1/_update",
  "displayName": "Update Vendor",
  "orderNumber": 0,
  "enabled": false,
  "serviceCode": "vendor",
  "code": "null",
  "path": ""
},

{
  "id": {{PLACEHOLDER3}},
  "name": "Vendor Driver Create",
  "url": "/Vendor/driver/v1/_create",
  "displayName": "Vendor Driver Create",
  "orderNumber": 1,
  "parentModule": "",
  "enabled": false,
  "serviceCode": "vendor",
  "code": "null",
  "path": ""
},
{
  "id": {{PLACEHOLDER4}},
  "name": "Vendor Driver Update",
  "url": "/Vendor/driver/v1/_update",
  "displayName": "Vendor Driver Update",
  "orderNumber": 1,
  "parentModule": "",
  "enabled": false,
  "serviceCode": "vendor",
  "code": "null",
  "path": ""
},
{
  "id": {{PLACEHOLDER5}},
  "name": "Vendor Driver Search",
  "url": "/Vendor/driver/v1/_search",
  "displayName": "Vendor Driver Search",
  "orderNumber": 1,
  "parentModule": "",
  "enabled": false,
  "serviceCode": "vendor",
  "code": "null",
  "path": ""
}

• Role Action Mapping:

API List

1. Vehicle Service

Vehicle Registry is a system that enables ULB Employees to create and search Vehicle Entities and schedule Vehicle Trip for FSM Application and track the VehicleTrip.

• MDMS Actions & Role Action Mapping for Vendor

 {
    "id": {{PLACEHOLDER1}},
    "name": "Create Vehicle Application",
    "url": "/vehicle/v1/_create",
    "displayName": "Create Vehicle",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "vehicle",
    "code": "null",
    "path": ""
  },
  {
    "id":  {{PLACEHOLDER2}},
    "name": "Search Vehicle Application",
    "url": "/vehicle/v1/_search",
    "displayName": "Search  Vehicle",
    "orderNumber": 1,
    "enabled": false,
    "serviceCode": "vehicle",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER3}},
    "name": "Vehicle Trip Search",
     "url": "/vehicle/trip/v1/_search",
    "displayName": "Vehicle Trip Search",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER4}},
    "name": "Vehicle Trip Update",
     "url": "/vehicle/trip/v1/_update",
    "displayName": "Vehicle Trip Update",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER5}},
    "name": "Vehicle Trip Create",
    "url": "/vehicle/trip/v1/_create",
    "displayName": "Vehicle Trip Create",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "vehicle",
    "code": "null",
    "path": ""
  },
  {
    "id": {{PLACEHOLDER6}},
    "name": "Update Vehicle Application",
    "url": "/vehicle/v1/_update",
    "displayName": "Update Vehicle",
    "orderNumber": 0,
    "enabled": false,
    "serviceCode": "vehicle",
    "code": "null",
    "path": ""
  }

• Role Action Mapping:

API List

To add new ulb/tenant for FSM,following steps should be followed:

• Add data in MDMS

• After this,restart the mdms service and check the status in ui.The tenant will be added in ui.

• Create Employee and FSTP login credientials.

• Plant Mapping of tenant

• Push the localisation of all the slums and Gram Panchayat in tenant.

• Push the billing-slab of new tenant

• Push the vendor-vehicle data of new tenant

The data templates contains Annexures which will be provided by the Program Team.

• Annexure -1 : ULB and FSTP data.

• Annexure -2 : Cesspool Vehicles

• Annexure -3 : Slum Within ULB

• Annexure -4 : Zero Pricing Property

• Annexure -5 : GP Tagging and Pricing

1. Annexure -1 : ULB and FSTP data This Annexure contains the names and contact details provided for -

   FSM Executive(Sl. No. A6) : CREATOR, COLLECTOR, EDITOR, DASHBOARD VIEWER, FSSM REGISTRY

   FSM TRP(Sl. No. B7) : SUBMIT/DECLINE TRIPS, ADD VEHICLE LOG

   Sl. No. A1 - A4 : ULB Details added in tenant/tenants.json file in mdms

   Sl. No. B1 - B6 : FSTP Details added in FSM/FSTPPlantInfo.json file in mdms

1. Annexure -2 : Cesspool Vehicles

The Contractor Details are the DSO/Vendor/Cesspool Operator details can be added from vendor api or FSM Registery to add dso in the portal.The driver and vehicle is assigned to the dso.

Vehicle Make,Model and Vehicle Tank capacity is added in MDMS under VehicleMakeModel.json file within Vehicle folder in mdms-repo.

According to Tank Capacity,Property Type,Sub-property Type and Slums,the pricing is defined in billing-slab.

1. Annexure -3 : Slum Within ULB The ULB can configure zero pricing for slums at a ULB level - all applications raised from slums would be required to pay zero application fees When creating an application, the default Slum Name is set to 'NONE'. If the user resides in a slum area, they have the option to select a specific Slum Name as follows:

   1. Open the Septic tank emptying request.

   2. In the 'Slum Name' field, you will find 'NONE' as the default value.

   3. If you live in a slum area, click on the 'Slum Name' field to open a dropdown menu.

   4. From the dropdown menu, select your specific slum area from the available options.

   By selecting the appropriate slum name, you can accurately specify your residential location within the application.

The slum details are added in specific ulb folder(anandapur/FSM/Slum.json).

1. Annexure -4 : Zero Pricing Property In Zero Pricing Property,ULB can opt for zero-price application based on some criteria(like slum, property, sub-property, capacity etc.) which is configurable in MDMS & billing_slab table .In case of zero-pricing, no demand will be generated and collection step will get skipped.

   Eg. For Institutional.Temple,the price will be 0.

1. Annexure -5 : GP Tagging and Pricing When creating a new application, users can choose between local municipalities or urban supported villages. Based on their choice, they can select either a locality/mohalla or a Gram Panchayat (GP) area from the respective dropdown list. If a ULB employee selects GP, they can manually input a trip amount based on offline calculations, instead of using the auto-calculated amount available for urban areas. ULB employees and DSO Operation personnel should also be able to edit the number of trips, and the final amount must be a multiple of the initial amount entered in the application based on the number of trips.

The data related to Gram Panchayat are added in mdms under specific ulb folder(Example. anandapur/egov-location/boundary-data.json to show in the ui.

For adding the rate slabs(pricing) of vehicles,consider different combination of propertyType , slum and tank capacity.

• Required combination of property types and Sub-property types added in MDMS :

1. RESIDENTIAL and RESIDENTIAL.SUB-PROPERTY_TYPE

2. INSTITUTIONAL and INSTITUTIONAL.SUB-PROPERTY_TYPE

3. COMMERCIAL and COMMERCIAL.SUB-PROPERTY_TYPE

• Consider billing slab property types and Sub-property types for both slum and non-slum areas.Take slum='YES' for slum areas and take slum='NO' for non-slum areas.

• Sample Data for pricing : - The pricing is provided according to Vehicle capacity,property-types and slum areas.

Within the tenant,For two Vehicles having the same capacity,the pricing should be same. Example : In Vehicle-1 and Vehicle-3,for capacity 1000,pricing for Residential properties with Slum='NO' = 1000 Commercial properties with Slum='NO' = 1000 Institutional properties with Slum='NO' = 1000 Residential properties with Slum='YES' = 800 Commercial properties with Slum='YES' = 800 Institutional properties with Slum='YES' = 800

• Loading Rate Slabs Steps:

1. Import this collection - https://www.getpostman.com/collections/d039948bfdf20f7286ad

2. Change the request url specific to environment.

For search billing-slab(url) - https://sujog-dev.odisha.gov.in/fsm-calculator/v1/billingSlab/_search? tenantId=od.rourkela&limit=-1

For create billing-slab(url) - https://sujog-dev.odisha.gov.in/fsm-calculator/v1/billingSlab/_create

For update billing-slab(url) - https://sujog-dev.odisha.gov.in/fsm-calculator/v1/billingSlab/_update

1. Login from FSM_ADMINDEV credentials(for sujog-dev) which is having FSM Admin role for all the ulb’s.

2. Copy the auth token. Paste the auth token in the req. Body “authToken” field.

3. Download these files - https://drive.google.com/drive/folders/1cmEcpnvOHiGeq0pKpuznzWKoIYXL4VEI?usp=sharing and update the file by changing the different combination of propertyType , slum and tank capacity with respect to tenant/ulb.

4. Open the runner tab (ctrl+shift+R) and import the file which is shared in the step 5. (For example: billing-athagarh.json for pushing athagarh billing slab).

5. Drag the api which is provided in Step 1 collection.

6. Hit the postman collection.

IMPORTANT POINTS:

1.The format of billing slab data is:

{
    "tenantId": "{{tenantId}}",
    "capacityFrom": "{{capacityFrom}}",
    "capacityTo": "{{capacityTo}}",
    "propertyType": "{{propertyType}}",
    "slum": "{{slum}}",
    "price": "{{price}}",
    "status": "{{status}}"
}

Eg.

{
    "tenantId": "pg.rourkela",
    "capacityFrom": 0,
    "capacityTo": 1000,
    "propertyType": "RESIDENTIAL",
    "slum": "YES",
    "price": 800,
    "status": "ACTIVE"
}

2.The capacity always starts from 0.

3.Example. If the given capacity is 1000 and 3000 then the range should be:

"capacityFrom": 0,

"capacityTo": 1000,

"capacityFrom": 1001,

"capacityTo": 3000,

4.Consider billing-slab for both slum and non-slum areas.

5.The status is always ACTIVE.

6.If the price of all the slums is given as 0,then mark zeroPricingStatus as true otherwise mark it as false in MDMS.

How to update billing slab data:

1. The format of updating billing slab data is:

{
    "id": "{{id}}",
    "tenantId": "{{tenantId}}",
    "capacityFrom": "{{capacityFrom}}",
    "capacityTo": "{{capacityTo}}",
    "propertyType": "{{propertyType}}",
    "slum": "{{slum}}",
    "price": "{{price}}",
    "status": "{{status}}",
    "auditDetails": {
        "createdBy": "0ea42eb0-4406-4acf-91b0-52eca31403ab",
        "lastModifiedBy": "0ea42eb0-4406-4acf-91b0-52eca31403ab",
        "createdTime": 1685258218048,
        "lastModifiedTime": 1685258218048
    }
}

2.If the need is to update the price for all the slums from 800 to 500,for this Take the response from search api for slum “YES”,make a json file with updated price and push it using runner with the syntax mentioned in point 1.

Eg. https://drive.google.com/file/d/11GqEB3mtDO2A9g5P6ilbBOUSuN0kPGgx/view?usp=sharing

Zero Pricing property in billing-slab :

For some combination of property types and sub-property types,the zero pricing property is given.For that,the price will be considered as 0(zero) for all the capacities and slum areas.

1. Import the curl :

2. Login to Super_user and copy the auth token

3. Change the req. Url to env you want to push also the auth token

4. Add the localisation message in the request body.

5. Hit the url.

Reference Localisation Doc :

Important points :

1. Related modules for FSM : rainmaker-fsm,rainmaker-common,rainmaker-dss

2. Push the localisation for all the modules separately

3. After pushing the localisation,make a file to store all the localisations according to modules.

• Import this curl :

• Login from FSTP credientials and copy the uuid of FSTP user.

• Take FSTP plantCode from PlantInfo.json file for specific ulb.

• The status should be always ACTIVE.

• Login from FSM_ADMINDEV credentials(for sujog-dev) which is having FSM Admin role for all the ulb’s.

• Copy the auth token and user-info. Paste the auth token in the req. Body “authToken” field.

• Hit the url.

• Sample of SMS present in FSM product :

• The above SMS needs to be registered with specific TEMPLATE ID(Eg.'1407169140018862465') for each Localization key from the state Government/Client on their respective SMS portals.

• Append the TEMPLATE ID at the end of message. Example.

• Push the sms templates in Localisation. SMS related to OTP:

After adding all the data for ulb in MDMS,next step is to create user for Employee and FSTP.

From HRMS, Create Employee user and FSTP user of new tenant and add roles to it.

EMPLOYEE USER Example

FSTP USER Example

• Set the password of EmployeeId by checking the logs of sms service.

Ways to load Vendor details :

• From Api

• By FSM Registry

Loading from API :

Steps:

1. Import this collection -

2. Change the request url specific to environment.

For Create DSO(URL) :

For Search DSO(URL) :

For Update DSO(URL) :

1. Login from FSM_ADMINDEV credentials(for sujog-dev) which is having FSM Admin role for all the ulb’s.

2. Copy the auth token. Paste the auth token in the req. Body “authToken” field.

3. Request Info (eg. anandapur ulb) for Create DSO :-

Note:

2. No special characters allowed in Vendor name.

3. Vehicle Registration number should be unique for every vehicle.

4. Scenerios for Vendor and Vehicle users: - One Vendor can be linked with two or more vehicles. - One Vehicle is linked with One Vendor. - Two Vendors can’t have same mobile number because vendor is a user and user is stored uniquely in database. - Vendor owner, Vehicle owner and Driver owner can be same or different for One Vehicle.

5. Hit the url it’ll push the data of vendor.

From FSM Registry :

Add details of Cesspool Operator,Vehicle and Driver from FSM Registry and link Vehicle with Cesspool operator and Driver with Cesspool Operator.