FSM v 1.3.1

Overview

Faecal sludge management (FSM) is a system that enables citizen to raise a request for septic tank cleaning with there ULB’s directly or reaching out to ULB counter. Citizen can track the application, make a payment for the charges and rate the service. This document contains the details about how to setup the fsm and describes the functionalities it provides.

This document contains the details about the features enhancements being released as part of FSM v1.3 release. For core fsm functionalities and how to setup the fsm please refer FSM v1.0 documentation.

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-persister config path added in it
PSQL server is running and database is created to store FSM Application data
(Optional) Indexer config for fsm is added in egov-indexer yaml paths to index the generated data. Index are required for data visualisation in kibana or in DSS.
Following services should be up and running:
- egov-user
- egov-workflow-v2
- egov-perister
- egov-localization
- egov-notification-sms
- egov-mdms
- egov-idgen
- egov-url-shortening
- vehicle
- vendor
- fsm-calculator
- billing-service
- collection-services

Key Functionalities

EXISTING

Citizen can file, track and rate the application for cleaning septic tank
ULB Employee can file application for cleaning septic tank on behalf of Citizen
ULB Employee can assign DSO to the given application with possible service date
DSO can accept or reject the application
DSO or ULB Employee can Complete the FSM Application after cleaning the septic tank
FSM Admin in ULB can cancel the application at any stage before completing the application
ULB Employee or Admin can view the audit log of the given application
Capture citizen gender information if not present or pre-populate the gender information when Citizen is creating FSM application.
Add citizen's choice for payment
Introducing Pre pay and Post pay service
Post Pay service : Workflow changes (Desludging Application and Vehicle Trip)
Post Pay service: Employee Flow Enhancements
Add payment selection for DSO
Post Pay service: Number of trips is made editable and price calculation will be now based on number of trips entered by the DSO.
Capture DSO and FSTPO gender
Show citizen gender on FSM DSS
Select vehicle capacity instead of vehicle make.
Citizen Notifications | Payment Options | Timeline Enhancements
FSTPO Vehicle Log Inbox Enhancements
FSTPO can decline the vehicle trip
Add owner attribute for vehicle
Add ULB contact details in FSM application flow
DSO can edit pit and property usage details
Show vehicle trip status in employee inbox along with Desludging application
Unrestricted assignment of service requests to a single vehicle
Vehicle logging at FSTP decoupled from FSM module
Photo and attachment view in the application of the ULB employee UI
Dashboard enhancement

Advance Pay service: Employee Flow Enhancements
Introduce two new workflow in the system.
- FSM_ADVANCE_PAY_SERVICE and FSM_ZERO_PAY_SERVICE .
Advance Pay service: Number of trips is made editable(increase or decrease based on the requirement) and price calculation will be now based on number of trips entered by the DSO or ULB.
Allowed to pay part payment while creating the application.
ULB and DSO are allowed to decrease the number of trips if not required and if full payment is not done.
ULB and DSO are allowed to increase or decrease the number of trips n number of times.
With the updated number of trips, an updated bill will be generated .
Delink the payment from dso in progress state .
Zero Pay service: Employee Flow Enhancements
Zero Pay service: System now skip the collection and will not generate the demand for zero price application.
Demand Generation Process: Generating demand on every time when the trip is update.
Demand Generation Process: Added validation not to complete the application from ulb side before completing the all payment.
Enhancement of FSM Receipt

ENHANCEMENT

Part Search : The search functionality on the application page now includes the ability to search by a partial Application Number. This means that users can enter any part of the Application Number and retrieve all relevant results that match that specific part.
For instance, if the Application Number is "107-FSM-2023-04-28-006973", users can search for any part of the Application Number, such as "107", "fsm", "2023", or "006973" and retrieve all relevant results that match that specific part.
It is important to note that this search is not case sensitive, which means that the search results will be the same regardless of whether the user enters uppercase or lowercase letters.

Deployment Details

Deploy the latest version of fsm
Add fsm-persister.yml file in config folder in git and add that path in persister . (The file path is to be added in environment yaml file in param called persist-yml-path ) and restart the egov-persister service.
If index are to be created add the indexer config path in indexer service. (The file path is to be added in environment yaml file in param called egov-indexer-yaml-repo-path) and restart egov-indexer service.

Configuration Details

Make changes in config accordingly and restart the pdf-services.

1 . pdf-service/format-config/fsm-receipt.json

#SM-1265 FSM V1.2: ULB collecting advance Receipt Page · egovernments/configs@57259f7

#SM-1265 pdf Receipt table alignment · egovernments/configs@1e0625e

https://github.com/egovernments/configs/commit/1b3c14bfcf74ec23e30aed1910dfe0d016439543

https://github.com/egovernments/configs/commit/f6f7f513799dfcae80817fe1f1866d0084291006

2 . pdf-service/data-config/fsm-receipt.json

#SM-1265 FSM V1.2: ULB collecting advance Receipt Page · egovernments/configs@ed9220a

https://github.com/egovernments/configs/commit/2a221ad39756c2ca4476c0669c2f4f79c3ce958e

https://github.com/egovernments/configs/commit/a07318256f21240df71f87af21acd3dc56fb1118

https://github.com/egovernments/configs/commit/e307007a6e9f69f32134caac7d3b571411dfa840

egov-persister/fsm-persister.yaml

#807 updating advance amount column · egovernments/configs@413c9d1

https://github.com/egovernments/configs/commit/89ab16cc3c58d161183a58e85d4d9fdbe32a67f5

https://github.com/egovernments/configs/commit/4c3acfe57d9ef6770a814d9e3d8bd88493e5c4bb

MDMS Configuration

Add master data in MDMS service with module name as FSM and restart the egov-mdms-service . Following is some sample master data for

Application Channel ( Source )

{
    "tenantId": "pb",
    "moduleName": "FSM",
    "ApplicationChannel": [
        {
            "name": "Telephone",
            "code": "TELEPHONE",
            "active": true,
            "citizenOnly":false
        },
        {
            "name": "Counter",
            "code": "COUNTER",
            "active": true,
            "citizenOnly":false
        },
        {
            "name": "Online",
            "code": "ONLINE",
            "active": true,
            "citizenOnly":true
        }
    ]
}

CheckList ( Checklist to be answered by citizen while rating )

{
	"tenantId": "pb",
	"moduleName": "FSM",
	"CheckList": [{
			"code": "SPILAGE",
			"active": true,
			"required": true,
			"type": "SINGLE_SELECT",
			"options": [
				"YES",
				"NO",
				"NA"
			]
		},
		{
			"code": "SAFETY_GEARS_USED",
			"active": true,
			"type": "MULTI_SELECT",
			"required": true,
			"options": [
				"EYE_GEAR",
				"HAND_GLOVES",
				"NOSE_MASK"
			]
		},
		{
			"code": "NUMBER_OF_TRIPS",
			"active": true,
			"type": "DROP_DOWN",
			"required": false,
			"options": [
				"1",
				"2",
				"3",
				"4",
				"5",
				"6",
				"7",
				"8",
				"9",
				"10"
			]
		}
	]
}

Config ( Configuration at application level )

{
    "tenantId": "pb",
    "moduleName": "FSM",
    "Config": [
        {
            "code":"noOfTrips",
            "override":true,
            "default":1,
            "active":true,
            "description":"override:true indicates, noOfTrips poperty is allowed to override in FSM."
        },
        {
            "code":"additionalDetails.tripAmount",
            "override":false,
            "active":true,
            "description":"override:true indicates, tripAmount poperty is allowed to override in FSM."
        },
        {
            "code":"slumName",
            "override":true,
            "active":true,
            "description":"override:true indicates, tripAmount poperty is allowed to override in FSM."
        },
        {
            "code":"ALLOW_MODIFY",
            "WFState":"CREATED",
            "override":[
                "propertyUsage",
                "vehicleType",
                "sanitationtype",
                "address.pincode",
                "address.city",
                "address.locality",
                "address.street",
                "address.doorNo",
                "address.landmark",
                "pitDetail"
            ],
            "active":true,
            "description":"properties in override allowed to modify when FSM application moving from CREATED Status to next status."
        }
        
    ]
}

FSTP Plant Info ( FSTP information for each city )

PitType ( Type of pit )

Property Type

Slum ( Slums mapped to the locality of the city )

PaymentType (Payment preference type)

data/pg/FSM/ReceivedPaymentType.json

https://github.com/egovernments/egov-mdms-data/commit/4c028a70ccb715df9574d86dc99d11d93057d30e

https://github.com/egovernments/egov-mdms-data/commit/5a190371c2305131eac40b87b41c7b3f0eef092c

data/pg/FSM/CommonFieldsConfig.json

https://github.com/egovernments/egov-mdms-data/commit/4fac292e055665e5fbe4bfeaa7991c574a2289dc

FSM Persister YML

Integrate following below changes in fsm-persister.yml

https://github.com/egovernments/configs/commit/634a4fdd842ec69bdf735e8c985e36499661512f

data/pb/BillingService/BusinessService.json

Update BusinessService.json · egovernments/egov-mdms-data@96cd829

data/pb/DIGIT-UI/RoleStatusMapping.json

#SM-528 updating the status role for fsm collector · egovernments/egov-mdms-data@0d4b0c7

data/pb/BillingService/BusinessService.json

#SM-1435 added minAmountpayable in fsm · egovernments/egov-mdms-data@13e867b

data/pb/amritsar/FSM/ZeroPricing.json

https://github.com/egovernments/egov-mdms-data/commit/bccf684bd1343b3d280c1b87b1f03dcf62c96159

https://github.com/egovernments/egov-mdms-data/commit/7f3e6a02fc62bfdd9ee38dce2da9572ca9885866

data/pb/ACCESSCONTROL-ACTIONS-TEST/actions-test.json

https://github.com/egovernments/egov-mdms-data/commit/06a1bcaca5693a6037cce52eecd53083dd6bd26f

Dashboard Analytics Configuration

Following are the changes that need to be integrate in dashboard-analytics and restart the “dashboard-analytics” service

egov-dss-dashboards/dashboard-analytics/ChartApiConfig.json

https://github.com/egovernments/configs/commit/2ae2feecd343d17b908820b86664cee38293a719

https://github.com/egovernments/configs/commit/18e547df409b625b0934e4dc7251590c5f834f83

https://github.com/egovernments/configs/commit/f05d41d983a9ec5381183d3f26497dc2295ad169

https://github.com/egovernments/configs/commit/47c3592252b4236b9a785adf6dd7d0b4dd66e482

https://github.com/egovernments/configs/commit/5b716c195766a573fb542e41d3ca94b54b6aa248

egov-dss-dashboards/dashboard-analytics/MasterDashboardConfig.json

https://github.com/egovernments/configs/commit/c1c4b2ed5e5eb1b153c2648c3307f006566a5a6b

egov-indexer/egov-vehicle.yaml

https://github.com/egovernments/configs/commit/3d9faae0f42550a4e15dcad69630846ba0482de8

Business Service / Workflow Configuration

Create businessService (workflow configuration) using the /businessservice/_create. Following is the product configuration for FSM:

For post new Business service FSM_POST_PAY_SERVICE has been created .Create businessService (workflow configuration) using the /businessservice/_create. Following is the product configuration for FSM_POST_PAY_SERVICE:

Workflow Configuration Changes FSM 1.2.1

In system the FSM_POST_PAY_SERVICE and FSM (i.e above two Business service) are removed and we introduced below new Business service for advance payment application and zero price application.

For Advance new Business service FSM_ADVANCE_PAY_SERVICE has been created.

Create businessService (workflow configuration) using the /businessservice/_create. Following is the product configuration for FSM_ADVANCE_PAY_SERVICE:

For Advance Zero new Business service PAY_LATER_SERVICE has been created

Create businessService (workflow configuration) using the /businessservice/_create. Following is the product configuration for PAY_LATER_SERVICE:

For Zero Price Application new Business service FSM_ZERO_PAY_SERVICE has been created

Create businessService (workflow configuration) using the /businessservice/_create. Following is the product configuration for FSM_ZERO_PAY_SERVICE:

Localization Setup

Using /localization/messages/v1/_upsert , add localisation (templates) for notification messages to be sent. Following are the product notification templates:

FSM1.2.1 Localization changes

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.

Action Configuration

data/pg/ACCESSCONTROL-ACTIONS-TEST/actions-test.json

https://github.com/egovernments/egov-mdms-data/commit/3979963cd0281245c69f015da233a5501fb5f99f

data/pg/ACCESSCONTROL-ACTIONS-TEST/actions-test.json

https://github.com/egovernments/egov-mdms-data/commit/50b83c118d57f49920c51216a2f6596d81d6ed79

data/pg/ACCESSCONTROL-ACTIONS-TEST/actions-test.json

https://github.com/egovernments/egov-mdms-data/commit/0140a43e110d9677ac69de11d1c1fd1344aa12cd

Role Action Mapping

data/pg/ACCESSCONTROL-ROLEACTIONS/roleactions.json

https://github.com/egovernments/egov-mdms-data/commit/4d58943d8ab04aa5d8816821406b6e40017ec722

data/pg/ACCESSCONTROL-ROLEACTIONS/roleactions.json

https://github.com/egovernments/egov-mdms-data/commit/1b5962693ac70b7ac56fd312f4b2febab00f9c93

data/pg/ACCESSCONTROL-ROLEACTIONS/roleactions.json

https://github.com/egovernments/egov-mdms-data/commit/9f9b1340b42f25bca44fdcfa474a3413cc21ec03

Infra Ops Configuration

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

Description	name in values.yml	Current Value

Description	name in values.yml	Current Value
id-gen host, to generate the application number	`EGOV_IDGEN_HOST`	`egov-idgen` from `egov-service-host`
Kafka Consumer Group	`SPRING_KAFKA_CONSUMER_GROUP_ID`	`egov-fsm-service`
kafka topic to which service push data to save new fsm application	`PERSISTER_SAVE_FSM_TOPIC`	`save-fsm-application`
kafka topic to which service push data to save workflow status	`PERSISTER_UPDATE_FSM_WORKFLOW_TOPIC`	`update-fsm-workflow-application`
kafka topic to which service push data to update the existing fsm application	`PERSISTER_UPDATE_FSM_TOPIC`	`update-fsm-application`
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-calculator service host	`EGOV_FSM_CALCULATOR_HOST`	`fsm-calculator` from `egov-service-host`
workflow v2 service host	`WORKFLOW_CONTEXT_PATH`	`egov-workflow-v2` from `egov-service-host`
ui host, to return send the url of new application in sms notification	`EGOV_UI_APP_HOST`	`egov-services-fqdn-name` from `egov-service-host`
vendor service host, to get DSO details	`EGOV_VENDOR_HOST`	`vendor` from `egov-service-host`
Vehicle service host, to get vehicle details and manage vehicleTrip	`EGOV_VEHICLE_HOST`	`vehicle` from `egov-service-host`
Collection service host, to get the payment details	`EGOV_COLLECTION_SERVICE_HOST`	`collection-services` from `egov-service-host`
localization service host, to get the locale data	`EGOV_LOCALIZATION_HOST`	`egov-localization` from `egov-service-host`
user service host, to get the locale data	`EGOV_USER_HOST`	`egov-user` from `egov-service-host`
pdf service host, to get the locale data	`EGOV_PDF_HOST`	`pdf-service` from `egov-service-host`
url shortening service host, to get the short url for the long once	`EGOV_URL_SHORTNER_HOST`	`egov-url-shortening` from `egov-service-host`

Sample values.yml

Users

User	Role	Description	How to create

User	Role	Description	How to create
FSM Creator	`FSM_CREATOR_EMP`	Can create FSM Application on behalf of Citizen	Through HRMS with role
FSM Editor	`FSM_EDITOR_EMP`	Can edit the application created by citizen for demand generation Assing/ Re-Assign DSO Complete the Application	Through HRMS with role
FSM Admin	`FSM_ADMIN`	Can cancel the application at any stage of workflow	Through HRMS with role
DSO	`FSM_DSO`	can accept/Reject the assigned Application can complete the FSM Application	Through vendor service, use the create DSO Request from postman Collection
FSTP Operator	`FSM_EMP_FSTPO`	Can mark the vehicle Trip as disposed. Not FSM Service User	Through HRMS with role
Collector	`FSM_COLLECTOR`	Can collect the payment amount for application based on demand	Through HRMS with role

User with userType employee and role

FSM_CREATOR_EMP role

Integration

Integration Scope

FSM can be integrated with any ULB or system which wants to track FSM application. The organisations can customise the workflow depending on there product requirements

Integration Benefits

Easy tracking and resolution FSM Application
Configurable workflow according to client requirement

Steps to Integration

Citizen/ULB Employee can file Application request using the /fsm/v1/_create
Organisation or System can search the FSM Applications using /fsm/v1/_searchendpoint
Once the Application is files the organisation or system can call /fsm/v1/_update endpoint to move the application further in workflow until it get resolved

Inbox api

Introduced new inbox service to get the fsm applications in registered ULB employee inbox, With this ULB employee can track the application or perform the actions based on employee role.
ULB employee can also apply the filter to check the particular state or applications or any other filter as required.

FSM apply as service

As of now we are providing fsm as adhoc service. In order to avoid multiple times user has to create the fsm request every time, In the system itself after some particular days, we will create same fsm application and if user wants service, he will pay the amount .

MDMS changes

As we mentioned above, we need to define time paramter, in order to create periodic application.For that we added the periodic service master where we will configure the time limit and either schedular is enabled or not. Please find the below configuration and location.

https://github.com/egovernments/egov-mdms-data/blob/DEV/data/pb/amritsar/FSM/PeriodicService.json

{ "tenantId": "pb.amritsar",

"moduleName": "FSM",

"PeriodicService":[

{

"timeLimit" : 864000000,

"isSchedularConfiguration":true

}

]

}

cronjob will read the cron job’s configured in the cronjobapiconfig.json and based on the schedular time it will call the api which is configured.Please find the below configuration and file location.

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

{ "jobName": "daily",

"active": "true",

"method": "POST",

"url": "http://fsm.egov:8080/fsm/v1/_schedular",

"payload": {

"RequestInfo": "{DEFAULT_REQUESTINFO}" },

"header": { "Content-Type": "application/json"

}

We are using fsm/v1/_schedular api. This api will read the master data for each tenant and based on the time limit configured for that tenant, it will get the all eligiable aplications and create periodic applications for those fsm applications.

data/pb/FSM/AdvancePayment.json

SM-499 : mdms file for advanceBalance and cancellationfee · egovernments/egov-mdms-data@3b3233e

Update AdvancePayment.json · egovernments/egov-mdms-data@a864a90

Update CancellationFee.json · egovernments/egov-mdms-data@3a614e5

master-config.json

SM-499 adding advancepayment and cancellationfee · egovernments/egov-mdms-data@c4efb2e

Infra changes

We added new chart called mdms-read-cronjob.Please find the below chart location.

https://github.com/egovernments/DIGIT-DevOps/tree/master/deploy-as-code/helm/charts/utilities/mdms-read-cronjob

Interaction Diagram

1. Advance Amount Workflow

2. Zero Price Application Workflow

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
HRMS Technical Document	NEEDS TO BE UPDATED
API Contract	FSM API Contract
Postman Collection	FSM Postman Collection

API List

Title	Link
`/fsm/v1/_create`	https://api.postman.com/collections/23418568-946a158e-9391-44b2-9d2b-48f30ea8cd63?access_key=PMAT-01GSPRPC338T9RR0GAKTRCRDP8
`/fsm/v1/_update`	https://api.postman.com/collections/23418568-946a158e-9391-44b2-9d2b-48f30ea8cd63?access_key=PMAT-01GSPRPC338T9RR0GAKTRCRDP8
`/fsm/v1/_search`	https://www.getpostman.com/collections/a51486db12539a2aa597
`/fsm/v1/_audit`	https://www.getpostman.com/collections/a51486db12539a2aa597
`/fsm/v1/_plainsearch`	https://www.getpostman.com/collections/a51486db12539a2aa597
`/fsm/plantmap/v1/_create`	https://www.getpostman.com/collections/a51486db12539a2aa597
`/fsm/plantmap/v1/_update`	https://www.getpostman.com/collections/a51486db12539a2aa597
`/fsm/plantmap/v1/_search`	https://www.getpostman.com/collections/a51486db12539a2aa597
`/inbox/v1/_search`	https://www.getpostman.com/collections/a51486db12539a2aa597
/fsm/v1/_schedular	https://www.getpostman.com/collections/a51486db12539a2aa597

Overview

Pre-requisites

Key Functionalities

EXISTING

ENHANCEMENT

Deployment Details

Configuration Details

MDMS Configuration

Dashboard Analytics Configuration

Business Service / Workflow Configuration

Localization Setup

Actions & Role Action Mapping

Action Configuration

data/pg/ACCESSCONTROL-ACTIONS-TEST/actions-test.json

Role Action Mapping

Infra Ops Configuration

Sample values.yml

Users

Integration

Integration Scope

Integration Benefits

Steps to Integration

Interaction Diagram

1. Advance Amount Workflow

2. Zero Price Application Workflow

Reference Docs

Doc Links

API List

Title