Versions Compared

Old Version 3

changes.mady.by.user Kapil Gupta (Unlicensed)

Saved on

compared with

New Version 4

changes.mady.by.user Kapil Gupta (Unlicensed)

Saved on

Key

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

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.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

  • 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

Deployment Details

...

Deploy the latest version of fsm

...

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.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

  • 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

Deployment Details

  1. Deploy the latest version of fsm

  2. 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.

  3. 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.

...

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.

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

TBD

Reference Docs

...

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://www.getpostman.com/collections/a51486db12539a2aa597

...

 /fsm/v1/_update

...

https://www.getpostman.com/collections/a51486db12539a2aa597

...

/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

...

/vehicle/trip/v1/_create

...

https://www.getpostman.com/collections/4d425d97a5db5ced11b6

=====================================

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.jsonbelow configuration and location.

https://github.com/egovernments/egov-mdms-data/commitblob/DEV/3979963cd0281245c69f015da233a5501fb5f99fdata/pb/pgamritsar/ACCESSCONTROL-ROLEACTIONSFSM/roleactionsPeriodicService.json

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

data/pg/ACCESSCONTROL-ROLEACTIONS/roleactions.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/commitDEV/1b5962693ac70b7ac56fd312f4b2febab00f9c93data/pgpb/ACCESSCONTROLcommon-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

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.

Infra changes

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

https://github.com/egovernments/releasekitDIGIT-DevOps/tree/master/localisation/FSM%201.2.1/deploy-as-code/helm/charts/utilities/mdms-read-cronjob

Interaction Diagram

TBD

Reference Docs

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

/vehicle/trip

 /fsm/v1/_create

https://www.getpostman.com/collections/a51486db12539a2aa597

 /fsm/v1/_update

https://www.getpostman.com/collections/a51486db12539a2aa597

/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/

4d425d97a5db5ced11b6

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