v1.2.1
Platform
Domains
Design System Academy
Feedback

FSM Calculator

Details for setting up FSM calculator sevice

Overview

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

Generates the Demand after calculating the charges for the given application using the billing slab already configured. This document contains the details about how to set up the fsm-calculator service and a description of the functionalities it provides.

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 fsm-calculator-persister config path added to it

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

  • Following services should be up and running:

    • egov-persister

    • egov-mdms

    • fsm

    • billing-service

Key Functionalities

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

  • ULB Employee with FSM_CREATOR and FSM_EDITOR can search billing slab(s)

  • ULB Employee Citizen can file, track and rate the application for cleaning septic tank

  • ULB Employee can get the estimate for FSM Application

  • FSM service internally calls fsm-calculator to generate a demand

Deployment Details

  1. Deploy the latest version of FSM.

  2. Add fsm-calculator-persister.yml file in the config folder in git and add that path in persister. (The file path should be added in the environment yaml file in param called persist-yml-path)

Configuration Details

MDMS Configuration

FSM MDMS Configuration is sufficient

Business Service / Workflow Configuration

NA

Actions & Role Action Mapping

Actions

[
  {
    "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": ""
  },
  {
    "id": {{PLACEHOLDER4}},
    "name": "FSM Estimate",
    "url": "/fsm-calculator/v1/_estimate",
    "displayName": "FSM Estimate",
    "orderNumber": 1,
    "parentModule": "",
    "enabled": false,
    "serviceCode": "",
    "code": "null",
    "path": ""
  }
]

Role Action Mapping

[
  {
    "rolecode": "FSM_ADMIN",
    "actionid": "{{PLACEHOLDER1}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_ADMIN",
    "actionid": "{{PLACEHOLDER2}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_CREATOR_EMP",
    "actionid": "{{PLACEHOLDER3}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_EDITOR_EMP",
    "actionid": "{{PLACEHOLDER3}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_ADMIN",
    "actionid": "{{PLACEHOLDER3}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_DSO",
    "actionid": "{{PLACEHOLDER3}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_CREATOR_EMP",
    "actionid": "{{PLACEHOLDER4}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_EDITOR_EMP",
    "actionid": "{{PLACEHOLDER4}}",
    "actioncode": "",
    "tenantId": "pb"
  },
  {
    "rolecode": "FSM_ADMIN",
    "actionid": "{{PLACEHOLDER4}}",
    "actioncode": "",
    "tenantId": "pb"
  }
]

Infra Ops Configuration

Configurations that we can manage through values.yml fsm-calculator in infraops repo are listed below. values.yml for fms-calculator can be found here

Description

name in values.yml

Current Value

contextPath of the api’s

SERVER_CONTEXTPATH

/fsm-calculator

Kafka Consumer Group

SPRING_KAFKA_CONSUMER_GROUP_ID

fsm-calculator

kafka topic to which service push data to save new billing slab

PERSISTER_SAVE_BILLING_SLAB_TOPIC

save-fsm-billing-slab

kafka topic to which service push data to update the existing billing slab

PERSISTER_UPDATE_BILLING_SLAB_TOPIC

update-fsm-billing-slab

mdms service host

EGOV_MDMS_HOST

egov-mdms-service from egov-service-host

billing-service host

EGOV_BILLINGSERVICE_HOST

billing-service from egov-service-host

fsm service host

EGOV_FSM_HOST

fsm from egov-service-host

Configurations sample in Values.yml

  - name: SERVER_CONTEXTPATH
    value: /fsm-calculator
  - name: SPRING_KAFKA_CONSUMER_GROUP_ID
    value: fsm-calculator
  - name: PERSISTER_SAVE_BILLING_SLAB_TOPIC
    value: save-fsm-billing-slab
  - name: PERSISTER_UPDATE_BILLING_SLAB_TOPIC
    value: update-fsm-billing-slab
  - name: SPRING_KAFKA_PRODUCER_KEY_SERIALIZER
    value: org.apache.kafka.common.serialization.StringSerializer
  - name: SPRING_KAFKA_PRODUCER_VALUE_SERIALIZER
    value: org.springframework.kafka.support.serializer.JsonSerializer
  - name: EGOV_MDMS_HOST
    valueFrom:
      configMapKeyRef:
        name: egov-service-host
        key: egov-mdms-service
  - name: EGOV_BILLINGSERVICE_HOST
    valueFrom:
      configMapKeyRef:
        name: egov-service-host
        key: billing-service
  - name: EGOV_FSM_HOST
    valueFrom:
      configMapKeyRef:
        name: egov-service-host
        key: fsm

Data Setup

Billing Slab Setup

Create Billing Slabs based on distinct property types, slum details, and vehicle capacity details.

  • PropertyType values are available in PropertyType Mdms

  • Slum (Yes/No) - user input value either Yes or No

  • capacityFrom and capacityTo refers to Vehicle Tank Capacity

Sample Curl

curl --location --request POST 'http://localhost:9098/fsm-calculator/v1/billingSlab/_create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RequestInfo": {
        "apiInfo": {
            "id": "string",
            "version": "string",
            "path": "string"
        },
        "deviceDetail": {
            "id": "string",
            "signature": "string"
        },
        "ts": 0,
        "action": "string",
        "key": "string",
        "msgId": "string",
        "requesterId": "string",
        "authToken": "a35b5ba7-2d5f-4272-8a67-0303cfab2c9f"
    },
   "billingSlab":{
          
            "tenantId": "pb.amritsar",
            "capacityFrom": 1000.00,
            "capacityTo": 50000.00,
            "propertyType": "RESIDENTIAL.ROW_HOUSES",
            "slum": "NO",
            "price": 9000.00,
            "status": "ACTIVE"
        },
    "workflow": null
}'

Integration

Integration Scope

FSM-calculator is integrated with FSM Application. FSM Application internally invokes the fsm-calculator service to calculate and generate demand for the charges.

Integration Benefits

  • Calculation and demand generation logic will be separated from the FSM service. For each implementation, calculation implementation can be changed if required without modifying the fsm service.

Steps to Integration

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

  2. ULB employees can call fsm-calculator/v1/_estimate to get the estimates for the FSM application

  3. ULB employees can create billing slabs calling fsm-calculator/v1/billingSlab/_create

  4. ULB employees can update billing slabs calling fsm-calculator/v1/billingSlab/_update

  5. ULB employees can search billing slabs calling fsm-calculator/v1/billingSlab/_search

Interaction Diagram

TBD

Reference Docs

Doc Links

Title

Link

Workflow Technical Document

Workflow Service

User Technical Document

User Service

MDMS Technical Document

NEEDS TO BE UPDATED

IDGen Technical Document

NEEDS TO BE UPDATED

Localization Technical Document

NEEDS TO BE UPDATED

Persister Technical Document

NEEDS TO BE UPDATED

SMS Notification Technical Document

NEEDS TO BE UPDATED

API Contract

API Contract

Postman Scripts

Postman Scripts

API List

Title

Link

fsm-calulator/v1/_calculate

https://www.getpostman.com/collections/8b9eb951a810486f41a4

fsm-calculator/v1/_estimate

https://www.getpostman.com/collections/8b9eb951a810486f41a4

fsm-calculator/v1/billingSlab/_create

https://www.getpostman.com/collections/8b9eb951a810486f41a4

fsm-calculator/v1/billingSlab/_update

https://www.getpostman.com/collections/8b9eb951a810486f41a4

fsm-calculator/v1/billingSlab/_search

https://www.getpostman.com/collections/8b9eb951a810486f41a4

Last updated

All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.