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.1 release. For core fsm functionalities and how to setup the fsm please refer FSM v1.1.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
FSTO User Flow
DSO/Employee - Application assignment to Vehicle
Pictures uploaded by DSO should be viewed by ULB employees
Post-service: DSO/Employee mode of payment entry in timeline
Post-service: Employee mode of payment entry
Dashboard enhancement for FSM
Configuration Details
eGov Persister Configuration
Following are the below commits history that need to be take care and and restart the egov-persister service.
fsm-persister.yml
https://github.com/egovernments/configs/commit/634a4fdd842ec69bdf735e8c985e36499661512f in fsm-persister.yaml
vendor-persister.yaml
https://github.com/egovernments/configs/commit/95dd26f926ec44d07448926ee4b6b7e031847a57
vehicle-persister.yaml
https://github.com/egovernments/configs/commit/2e536376408a0f09a2afe03c478201f5d81edfe4
eGov Indexer Configuration
Following are the changes that need to be integrate in eGov Indexer and restart the “egov-indexer” service
egov-indexer/egov-vehicle.yaml
https://github.com/egovernments/configs/commit/3d9faae0f42550a4e15dcad69630846ba0482de8
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
MDMS Configuration
These are the below changes that needs to be integrated and restart the “egov-mdms-service” service
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
Action & Role Mapping
Integrate the changes related to action and role mapping and restart the “egov-accesscontrol” service
data/pg/ACCESSCONTROL-ACTIONS-TEST/actions-test.json
https://github.com/egovernments/egov-mdms-data/commit/3979963cd0281245c69f015da233a5501fb5f99f
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-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
data/pg/ACCESSCONTROL-ROLEACTIONS/roleactions.json
https://github.com/egovernments/egov-mdms-data/commit/9f9b1340b42f25bca44fdcfa474a3413cc21ec03
Workflow Configurations
Implement the change mentioned in this document link and restart egov-workflow-v2
Workflow Configuration Changes FSM 1.2.1
Localization Configurations
Implement the change mentioned in this document link and restart egov-localization
https://github.com/egovernments/releasekit/tree/master/localisation/FSM%201.2.1
Reference Docs
Doc Links
Title | Link |
Workflow Technical Document | |
User Technical Document | |
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 | |
Postman Collection |
API List
Title | Link |
/vehicle/trip/v1/_create | |
Add Comment