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.
...
| Code Block |
|---|
{
"RequestInfo": {
"apiId": "Rainmaker",
"action": "",
"did": 1,
"key": "",
"msgId": "20170310130900|en_IN",
"requesterId": "",
"ts": 1513579888683,
"ver": ".01",
"authToken": "{{devAuth}}",
"userInfo": {
"id": 73,
"userName": null,
"name": null,
"type": "EMPLOYEE",
"mobileNumber": null,
"emailId": null,
"roles": [
{
"id": 2,
"name": "Customer Support Representative",
"code": null,
"tenantId": null
}
],
"tenantId": null,
"uuid": "uuid"
}
},
"BusinessServices": [
{
"tenantId": "pb.amritsar",
"uuid": "047a541b-ed5e-46aa-9fee-24c9674be9c3", "businessService": "FSM",
"business": "fsm",
"businessServiceSla": 5184000000,172800000,
"states": [
{
"tenantId": "pb.amritsar",
"sla": null,
"state": null,
"applicationStatus": null,
"docUploadRequired": false,
"isStartState": true,
"isTerminateState": false,
"isStateUpdatable": true, "isStateUpdatable": true,
"actions": [
{ {
"tenantId": "pb.amritsar",
"action": "CREATEAPPLY",
"nextState": "CREATEDPENDING_APPL_FEE_PAYMENT",
"roles": [
"CITIZEN" "FSM_CREATOR_EMP"
]
}, },
{ {
"tenantId": "pb.amritsar",
"action": "APPLYCREATE",
"nextState": "PENDING_APPL_FEE_PAYMENTCREATED",
"roles": [
"FSM_CREATOR_EMP" "CITIZEN"
] ]
} ] },
{ ]
"tenantId": "pb.amritsar", },
"sla": null, {
"state": "CREATED", "applicationStatustenantId": "CREATEDpb",
"docUploadRequired": false, "sla": null,
"isStartState": false, "isTerminateStatestate": false"CREATED",
"isStateUpdatable": true, "applicationStatus": "CREATED",
"actions": [ {"docUploadRequired": false,
"tenantIdisStartState": "pb.amritsar"false,
"actionisTerminateState": "SUBMIT"false,
"nextStateisStateUpdatable": "PENDING_APPL_FEE_PAYMENT"true,
"rolesactions": [
"FSM_EDITOR_EMP"{
] "tenantId": "pb",
}, { "action": "REJECT",
"tenantId": "pb.amritsar", "nextState": "REJECTED",
"action": "REJECT", "nextStateroles": "REJECTED",[
"roles": [ "FSM_ADMIN"
"FSM_ADMIN" ]
] } },
] }, {
{ "tenantId": "pb.amritsar",
"sla": null, "stateaction": "PENDING_APPL_FEE_PAYMENT",SUBMIT",
"applicationStatusnextState": "PENDING_APPL_FEE_PAYMENT",
"docUploadRequired": false, "isStartStateroles": false, [
"isTerminateState": false, "isStateUpdatable": true,FSM_EDITOR_EMP"
"actions": [ ]
{ }
"tenantId": "pb.amritsar", ]
"action": "CANCEL", },
"nextState": "CANCELED", {
"roles": [ "tenantId": "pb",
"FSM_ADMIN" "sla": null,
] "state": "PENDING_APPL_FEE_PAYMENT",
}, "applicationStatus": "PENDING_APPL_FEE_PAYMENT",
{ "tenantIddocUploadRequired": "pb.amritsar"false,
"actionisStartState": "PAY"false,
"nextStateisTerminateState": "ASSIGN_DS0"false,
"rolesisStateUpdatable": [
true,
"CITIZENactions",: [
"FSM_COLLECTOR" {
] }"tenantId": "pb",
{ "action": "REJECT",
"tenantId": "pb.amritsar", "actionnextState": "SENDBACKREJECTED",
"nextState": "CREATED", "roles": [
"roles": [ "FSM_ADMIN"
] ]
} ] },
}, { "tenantId": "pb.amritsar",{
"sla": null, "statetenantId": "ASSING_DSOpb",
"applicationStatus": "ASSING_DSO", "docUploadRequiredaction": false"SENDBACK",
"isStartState": false, "isTerminateStatenextState": false"CREATED",
"isStateUpdatable": true, "actionsroles": [
{ "tenantId": "pb.amritsar","FSM_ADMIN"
"action": "CANCEL", ]
"nextState": "CANCELED", },
"roles": [ {
"FSM_ADMIN" "tenantId": "pb",
] }, "action": "PAY",
{ "tenantIdnextState": "pb.amritsarASSING_DSO",
"action "roles": "ASSIGN",[
"nextState": "PENDING_DSO_APPROVAL", "CITIZEN",
"roles": [ "FSM_EDITOR_EMPCOLLECTOR"
]
}, }
{ ]
"tenantId": "pb.amritsar", },
"action": "SENDBACK", {
"nextStatetenantId": "PENDING_APPL_FEE_PAYMENTpb",
"rolessla": [null,
"FSM_ADMIN""state": "ASSING_DSO",
]
"applicationStatus": "ASSING_DSO",
} "docUploadRequired": false,
] }, "isStartState": false,
{ "tenantIdisTerminateState": "pb.amritsar",false,
"slaisStateUpdatable": null,true,
"state": "DSO_REJECTED",actions": [
{
"applicationStatustenantId": "DSO_REJECTEDpb",
"docUploadRequired": false, "isStartStateaction": false"SENDBACK",
"isTerminateState": false, "isStateUpdatablenextState": true,"PENDING_APPL_FEE_PAYMENT",
"actions": [ "roles": [
{ "tenantId": "pb.amritsar" "FSM_ADMIN"
]
},
{
"tenantId": "pb",
"action": "CANCEL",
"nextState": "CANCELED",
"roles": [
"FSM_ADMIN"
]
},
{
"tenantId": "pb",
"action": "ASSIGN",
"nextState": "PENDING_DSO_APPROVAL",
"roles": [
"FSM_EDITOR_EMP"
]
}
]
},
{
"tenantId": "pb",
"sla": null,
"state": "DSO_REJECTED",
"applicationStatus": "DSO_REJECTED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb",
"currentState": "DSO_REJECTED",
"action": "CANCEL",
"nextState": "CANCELED",
"roles": [
"FSM_ADMIN"
]
},
{
"tenantId": "pb",
"currentState": "DSO_REJECTED",
"action": "REASSING",
"nextState": "PENDING_DSO_APPROVAL",
"roles": [
"FSM_EDITOR_EMP"
]
},
{
"tenantId": "pb",
"currentState": "DSO_REJECTED",
"action": "SENDBACK",
"nextState": "PENDING_DSO_APPROVAL",
"roles": [
"FSM_ADMIN"
]
}
]
},
{
"tenantId": "pb",
"sla": null,
"state": "DSO_INPROGRESS",
"applicationStatus": "DSO_INPROGRESS",
"docUploadRequired": false,
"actionisStartState": "ASSIGN"false,
"nextStateisTerminateState": "PENDING_DSO_APPROVAL"false,
"rolesisStateUpdatable": [true,
"actions": [
"FSM_EDITOR_EMP" {
] }, "tenantId": "pb",
{ "tenantIdcurrentState": "pb.amritsarDSO_INPROGRESS",
"action": "CANCELSENDBACK",
"nextState": "CANCELEDPENDING_DSO_APPROVAL",
"roles": [
"FSM_ADMIN"
]
}, },
{ {
"tenantId": "pb.amritsar", "actiontenantId": "SENDBACKpb",
"nextStatecurrentState": "PENDING_DSO_APPROVAL",DSO_INPROGRESS",
"rolesaction": ["DECLINE",
"nextState": "FSMASSING_ADMINDSO",
] "roles": [
} ] }, "FSM_DSO",
{ "tenantId": "pb.amritsar", "sla": null,FSM_EDITOR_EMP"
"state": "DSO_INPROGRESS", "applicationStatus": "DSO_INPROGRESS",]
"docUploadRequired": false, },
"isStartState": false, "isTerminateState": false, {
"isStateUpdatable": true, "actions": [ "tenantId": "pb",
{ "tenantIdcurrentState": "pb.amritsarDSO_INPROGRESS",
"action": "COMPLETED",",
"nextState": "CITIZEN_FEEDBACK_PENDING",
"roles": [
"FSM_DSO",
"FSM_EDITOR_EMP" "FSM_EDITOR_EMP"
] },]
{ },
"tenantId": "pb.amritsar", {
"action": "DECLINE", "nextStatetenantId": "ASSIGN_DS0pb",
"roles": [ "currentState": "DSO_INPROGRESS",
"FSM_DSO" "action": "CANCEL",
] }, "nextState": "CANCELED",
{ "tenantIdroles": "pb.amritsar",[
"action": "CANCEL", "nextStateFSM_ADMIN":
"CANCELED", "roles": [ ]
"FSM_ADMIN" }
] ]
} },
] }, {
{ "tenantId": "pb.amritsar",
"sla": null,
"state": "PENDING_DSO_APPROVAL",
"applicationStatus": "PENDING_DSO_APPROVAL",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": true,
"actions": [
{
"tenantId": "pb.amritsar",",
"currentState": "PENDING_DSO_APPROVAL",
"action": "DSO_ACCEPTREJECT",
"nextState": "DSO_INPROGRESSREJECTED",
"roles": [
"FSM_DSO" "FSM_DSO"
] },]
{ },
"tenantId": "pb.amritsar", {
"action": "CANCEL", "nextStatetenantId": "CANCELEDpb",
"roles": [ "currentState": "PENDING_DSO_APPROVAL",
"FSM_ADMIN" "action": "DSO_ACCEPT",
] }, "nextState": "DSO_INPROGRESS",
{ "roles": [
"tenantId": "pb.amritsar", "action": "SENDBACK", "FSM_DSO"
"nextState": "ASSIGN_DS0", ]
"roles": [ },
"FSM_ADMIN" {
] }, "tenantId": "pb",
{ "tenantIdcurrentState": "pb.amritsarPENDING_DSO_APPROVAL",
"action": "DSO_REJECTCANCEL",
"nextState": "DSO_REJECTEDCANCELED",
"roles": [
"FSM_DSOADMIN"
]
}
]
},
{ {
"tenantId": "pb.amritsar",
"sla": null,
"state": "COMPLETED",
"applicationStatus": "COMPLETED",,
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false, "isStateUpdatable": false
"actions": null },
{ {
"tenantId": "pb.amritsar", "sla": null,
"state": "REJECTED",
"applicationStatus": "REJECTED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,
"isStateUpdatable": false,
"actions": null
},
{
"tenantId": "pb.amritsar",
"sla": null,
"state": "CANCELED",
"applicationStatus": "CANCELED",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": true,,
"isStateUpdatable": false,
"actions": null
}, },
{ {
"tenantId": "pb.amritsar",
"sla": null,
"state": "CITIZEN_FEEDBACK_PENDING",
"applicationStatus": "CITIZEN_FEEDBACK_PENDING",
"docUploadRequired": false,
"isStartState": false,
"isTerminateState": false,
"isStateUpdatable": false,
"actions": [
{
"tenantId": "pb.amritsar",
"currentState": "CITIZEN_FEEDBACK_PENDING",
"action": "SUBMIT_FEEDBACK",
"nextState": "COMPLETED",
"roles": [
"CITIZEN"
]
}
]
}
]
}
]
} |
Localization Setup
Using /localization/messages/v1/_upsert , add localisation (templates) for notification messages to be sent. Following are the product notification templates:
...
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 |
...