Page Comparison

...

Apply for water connection.
Searching for water connections.
Apply for Property creation.
Can take different action based on state (Workflow)
Notification based on the application state.

Environment Variables	Description
`egov.waterservice.createwaterconnection`	This variable contains the kafka topic name which is used to create new water connection application in the system.
`egov.waterservice.updatewaterconnection`	This variable contains the kafka topic name which is used to update the existing water connection application in the system.
`egov.waterservice.updatewaterconnection.workflow.topic`	This variable contains the kafka topic name which is used to update the process instance of the water connection application.
`egov.idgen.wcapid.name`	This variable contain the idgen format name for water application
`egov.idgen.wcapid.format`	This variable contain the idgen format for water application ex:- WS/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]
`egov.idgen.wcid.name`	This variable contain the idgen format name for water connection
`egov.idgen.wcid.format`	This variable contain the idgen format for water connection ex:- WS_AP/[CITY.CODE]/[fy:yyyy-yy]/[SEQ_EGOV_COMMON]

Interaction Diagram:

To Do

...

Code Block

[
  {
      "id": {{PLACEHOLDER1}},
      "name": "Create Water Connection",
      "url": "/ws-services/wc/_create",
      "displayName": "Create Water COnnection",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-services",
      "code": "null",
      "path": ""
    },
    {
      "id": {{PLACEHOLDER2}},
      "name": "Search Water Connection",
      "url": "/ws-services/wc/_search",
      "displayName": "Search Water COnnection",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-services",
      "code": "null",
      "path": ""
    },
    {
      "id": {{PLACEHOLDER3}},
      "name": "Update Water Connection",
      "url": "/ws-services/wc/_update",
      "displayName": "Update Water COnnection",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "ws-services",
      "code": "null",
      "path": ""
    }
]

...

Code Block

[
  {,
    {
      "id": {{PLACEHOLDER4}},
      "rolecodename": "CITIZENBusinessService Search",
      "actionidurl": {{PLACEHOLDER1}}"/user/profile/_update",
      "actioncodeparentModule": "",
      "tenantIddisplayName": "pb",
    },     {"orderNumber": 0,
       "rolecodeenabled": "CITIZEN"false,
      "actionidserviceCode": {{PLACEHOLDER2}}"ADMIN",
      "actioncodecode": "null",
      "tenantIdpath": "pb"
    },
]

Role Action Mapping

Code Block

[
  {
      "rolecode": "CITIZENEMPLOYEE",
      "actionid": {{PLACEHOLDER3PLACEHOLDER1}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSGP_CEMPADMIN",
      "actionid": {{PLACEHOLDER1}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_CEMPSUPERUSER",
      "actionid": {{PLACEHOLDER2PLACEHOLDER1}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSGP_CEMPADMIN",
      "actionid": {{PLACEHOLDER3PLACEHOLDER1}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WS_DOC_VERIFIERSUPERUSER",
      "actionid": {{PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSGP_DOC_VERIFIERADMIN",
      "actionid": {{PLACEHOLDER3PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSCOLLECTION_FIELD_INSPECTOROPERATOR",
      "actionid": {{PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSBULK_FIELDDEMAND_INSPECTORPROCESSING",
      "actionid": {{PLACEHOLDER3PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSEXPENSE_APPROVERPROCESSING",
      "actionid": {{PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSDASHBOARD_APPROVERVIEWER",
      "actionid": {{PLACEHOLDER3PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    }, 
    {
      "rolecode": "WS_CLERKEMPLOYEE",
      "actionid": {{PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "WSGP_CLERKADMIN",
      "actionid": {{PLACEHOLDER3PLACEHOLDER2}},
      "actioncode": "",
      "tenantId": "pb"
    },
]

Workflow business service config:

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

Code Block

{  {
"RequestInfo": {     "apiIdrolecode": "RainmakerCOLLECTION_OPERATOR",
      "actionactionid": ""{{PLACEHOLDER2}},
      "didactioncode": 1"",
      "keytenantId": "pb"
    },
    {
"msgId": "20170310130900|en_IN",     "requesterIdrolecode": "EMPLOYEE",
      "tsactionid": 1513579888683,{{PLACEHOLDER3}},
      "veractioncode": ".01",
      "authTokentenantId": "{{Auth_Token}}pb"
    },
  "BusinessServices": [
    {
      "tenantIdrolecode": "pbGP_ADMIN",
      "businessServiceactionid": "NewWS1"{{PLACEHOLDER3}},
      "businessactioncode": "ws-services",
      "businessServiceSlatenantId": 259200000 "pb"
    },
    {
 "states": [     "rolecode": "SUPERUSER",
      "actionid": {{PLACEHOLDER3}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "GP_ADMIN",
      "actionid": {{PLACEHOLDER3}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "SUPERUSER",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "GP_ADMIN",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "COLLECTION_OPERATOR",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "BULK_DEMAND_PROCESSING",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "EXPENSE_PROCESSING",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },
    {
      "rolecode": "DASHBOARD_VIEWER",
      "actionid": {{PLACEHOLDER4}},
      "actioncode": "",
      "tenantId": "pb"
    },    
    {
      "rolecode": "PROFILE_UPDATE",
      "actionid": 2001,
      "actioncode": "",
      "tenantId": "pb"
    }
]

Roles to be available:

Code Block


		{
      "code": "GP_ADMIN",
      "name": "GP Admin",
      "description": "Who has a access to ws-services"
    },
		{
      "code": "COLLECTION_OPERATOR",
      "name": "Collection Operator",
      "description": "Who has a access to ws-services,demand, bill and payment"
    },
		{
      "code": "BULK_DEMAND_PROCESSING",
      "name": "Bulk Demand Processing",
      "description": "Who has a access to bulk demand generation,raise bill, downloa bill and receipts"
    },
		{
      "code": "EXPENSE_PROCESSING",
      "name": "Expense Processing",
      "description": "Who has a access to create and update expenses"
    },
		{
      "code": "DASHBOARD_VIEWER",
      "name": "Dashbaord Viewer",
      "description": "Who has a access to dashboard of revenue and expenditure"
    }

Workflow business service config:

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

Code Block

{
  "RequestInfo": {
    "apiId": "Rainmaker",
    "action": "",
    "did": 1,
    "key": "",
    "msgId": "20170310130900|en_IN",
    "requesterId": "",
    "ts": 1513579888683,
    "ver": ".01",
    "authToken": "{{Auth_Token}}"
  },
  "BusinessServices": [
    {
      "tenantId": "pb",
      "businessService": "NewWS1",
      "business": "ws-services",
      "businessServiceSla": 259200000,
      "states": [
        {
          "sla": null,
          "state": null,
          "applicationStatus": null,
          "docUploadRequired": false,
          "isStartState": true,
          "isTerminateState": false,
          "isStateUpdatable": false,
          "actions": [
            {
              "action": "INITIATE",
              "nextState": "INITIATED",
              "roles": [
                "CITIZEN",
                "WS_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "INITIATED",
          "applicationStatus": "INITIATED",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "SUBMIT_APPLICATION",
              "nextState": "PENDING_FOR_DOCUMENT_VERIFICATION",
              "roles": [
                "CITIZEN",
                "WS_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
           "state": null "state": "PENDING_FOR_CITIZEN_ACTION",
          "applicationStatus": null"PENDING_FOR_CITIZEN_ACTION",
          "docUploadRequired": false,
          "isStartState": truefalse,
          "isTerminateState": false,
          "isStateUpdatable": falsetrue,
          "actions": [
            {
              "action": "INITIATERESUBMIT_APPLICATION",
              "nextState": "INITIATEDPENDING_FOR_DOCUMENT_VERIFICATION",
              "roles": [
                "CITIZEN",
                "WS_CEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "INITIATEDPENDING_FOR_DOCUMENT_VERIFICATION",
          "applicationStatus": "INITIATEDPENDING_FOR_DOCUMENT_VERIFICATION",
          "docUploadRequired": false,
          "isStartState": false,
          "isTerminateState": false,
          "isStateUpdatable": true,
          "actions": [
            {
              "action": "SUBMITVERIFY_AND_APPLICATIONFORWARD",
              "nextState": "PENDING_FOR_DOCUMENTFIELD_VERIFICATIONINSPECTION",
              "roles": [
                "CITIZEN",
                "WS_CEMP"
              ]
      DOC_VERIFIER"
     }           ]
        },    },
    {        {
  "sla": null,           "stateaction": "PENDING_FOR_CITIZEN_ACTIONREJECT",
              "applicationStatusnextState": "PENDING_FOR_CITIZEN_ACTIONREJECTED",
              "docUploadRequiredroles": false,[
          "isStartState": false,       "WS_DOC_VERIFIER"
   "isTerminateState": false,           "isStateUpdatable": true,]
           "actions": [ },
            {
              "action": "RESUBMIT_APPLICATIONSEND_BACK_TO_CITIZEN",
              "nextState": "PENDING_FOR_DOCUMENTCITIZEN_VERIFICATIONACTION",
              "roles": [
                "CITIZEN",
                "WS_DOC_CEMPVERIFIER"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "PENDING_FOR_DOCUMENT_VERIFICATIONREJECTED",
          "applicationStatus": "PENDING_FOR_DOCUMENT_VERIFICATIONREJECTED",
          "docUploadRequiredisStateUpdatable": false,
          "isStartStatedocUploadRequired": false,
          "isTerminateStateisStartState": false,
          "isStateUpdatableisTerminateState": true,
        },
 "actions":  [     {
       {   "sla": 86400000,
          "actionstate": "VERIFYPENDING_FOR_ANDFIELD_FORWARDINSPECTION",
  
           "nextStateapplicationStatus": "PENDING_FOR_FIELD_INSPECTION",
          "docUploadRequired": false,
    "roles": [     "isStartState": false,
          "WS_DOC_VERIFIERisStateUpdatable": true,
          "isTerminateState": false,
 ]             },"actions": [
            {
              "action": "REJECTVERIFY_AND_FORWARD",
              "nextState": "REJECTEDPENDING_APPROVAL_FOR_CONNECTION",
              "roles": [
                "WS_DOCFIELD_VERIFIERINSPECTOR"
              ]
            },
            {
              "action": "SEND_BACK_TO_CITIZENREJECT",
              "nextState": "PENDING_FOR_CITIZEN_ACTIONREJECTED",
              "roles": [
                "WS_DOCFIELD_VERIFIERINSPECTOR"
              ]
            },
            {
 ]         },    "action": "SEND_BACK_FOR_DOCUMENT_VERIFICATION",
   {           "slanextState": null"PENDING_FOR_DOCUMENT_VERIFICATION",
          "state": "REJECTED",   "roles": [
      "applicationStatus": "REJECTED",         "WS_FIELD_INSPECTOR"
 "isStateUpdatable": false,           "docUploadRequired": false, ]
          "isStartState": false, }
         "isTerminateState": true]
        },
        {
          "sla": 8640000043200000,
          "state": "PENDING_APPROVAL_FOR_FIELD_INSPECTIONCONNECTION",
          "applicationStatus": "PENDING_APPROVAL_FOR_FIELD_INSPECTIONCONNECTION",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatable": true,
          "isTerminateState": false,
          "actions": [
            {
              "action": "VERIFYAPPROVE_ANDFOR_FORWARDCONNECTION",
              "nextState": "PENDING_APPROVAL_FOR_CONNECTIONPAYMENT",
              "roles": [
                "WS_FIELD_INSPECTORAPPROVER"
              ]
            },
            {
              "action": "REJECT",
              "nextState": "REJECTED",
              "roles": [
                "WS_FIELD_INSPECTORAPPROVER"
              ]
            },
            {
              "action": "SEND_BACK_FOR_DOCUMENTFIELD_VERIFICATIONINSPECTION",
              "nextState": "PENDING_FOR_DOCUMENTFIELD_VERIFICATIONINSPECTION",
              "roles": [
                "WS_FIELD_INSPECTORAPPROVER"
              ]
            }
          ]
        },
        {
          "sla": 43200000,
          "state": "PENDING_APPROVAL_FOR_CONNECTIONPAYMENT",
          "applicationStatus": "PENDING_APPROVAL_FOR_CONNECTIONPAYMENT",
          "docUploadRequired": false,
          "isStartState": false,
          "isStateUpdatableisTerminateState": truefalse,
          "isTerminateStateisStateUpdatable": false,
          "actions": [
            {
              "action": "APPROVE_FOR_CONNECTIONPAY",
              "nextState": "PENDING_FOR_CONNECTION_PAYMENTACTIVATION",
              "roles": [
    
           "WS_APPROVER"   "roles": [
          ]      "CITIZEN",
      },          "WS_CEMP"
  {            ]
  "action": "REJECT",         }
     "nextState": "REJECTED",    ]
        },
 "roles": [      {
          "WS_APPROVERsla": null,
          "state": "PENDING_FOR_CONNECTION_ACTIVATION",
 ]         "applicationStatus": "PENDING_FOR_CONNECTION_ACTIVATION",
  },        "isStateUpdatable": true,
   {       "docUploadRequired": false,
      "action": "SEND_BACK_FOR_FIELD_INSPECTION",   "isStartState": false,
          "nextStateisTerminateState": "PENDING_FOR_FIELD_INSPECTION",
   false,
          "rolesactions": [
            {
   "WS_APPROVER"           "action": "ACTIVATE_CONNECTION",
   ]           "nextState": "CONNECTION_ACTIVATED",
}           ]   "roles": [
    },         {   "WS_CLERK"
       "sla": 43200000,      ]
    "state": "PENDING_FOR_PAYMENT",       }
   "applicationStatus": "PENDING_FOR_PAYMENT",      ]
    "docUploadRequired": false,   },
       "isStartState": false, {
          "isTerminateStatesla": falsenull,
          "isStateUpdatablestate": false"CONNECTION_ACTIVATED",
          "actionsapplicationStatus": ["CONNECTION_ACTIVATED",
            {
   "isStateUpdatable": false,
          "actiondocUploadRequired": "PAY",
  false,
           "nextStateisStartState": "PENDING_FOR_CONNECTION_ACTIVATION",
false,
             "rolesisTerminateState": [true
        }
      ]
"CITIZEN",    }
  ]
    }

Workflow for property creation through Water and Sewerage Module

Code Block

{
    "WS_CEMPBusinessServices": [
    {
        ]
"tenantId": "pb",
      "businessService": "PT.CREATEWITHWNS",
   }   "business": "PT",
      ]
"businessServiceSla": null,
       },"states": [
        {
          "sla": null,
          "state": "PENDING_FOR_CONNECTION_ACTIVATION"null,
          "applicationStatus": "PENDING_FOR_CONNECTION_ACTIVATIONINWORKFLOW",
          "isStateUpdatabledocUploadRequired": truefalse,
          "docUploadRequiredisStartState": falsetrue,
          "isStartStateisTerminateState": false,
          "isTerminateStateisStateUpdatable": false,
          "actions": [
            {
              "action": "ACTIVATE_CONNECTIONOPEN",
              "nextState": "INITIATED",
              "roles": [
                "CONNECTION_ACTIVATEDCITIZEN",
                "roles": [WS_CEMP",
                "WSSW_CLERKCEMP"
              ]
            }
          ]
        },
        {
          "sla": null,
          "state": "CONNECTION_ACTIVATEDINITIATED",
          "applicationStatus": "CONNECTION_ACTIVATEDINWORKFLOW",
          "isStateUpdatabledocUploadRequired": false,
          "docUploadRequiredisStartState": falsetrue,
          "isStartStateisTerminateState": false,
          "isTerminateStateisStateUpdatable": true
,
       }   "actions": [
  ]     }   ] }

Workflow for property creation through Water and Sewerage Module

Code Block

{
    "BusinessServices": [

     {         "tenantIdaction": "pbSUBMIT",
  
     "businessService": "NewWS1",         "businessnextState": "ws-servicesAPPROVED",
  
     "businessServiceSla": 259200000,         "states": [
  roles": [
       {         "EMPLOYEE",
   "sla": null,             "stateCITIZEN":,
  null,             "applicationStatus": "INWORKFLOWSW_CEMP",
             "docUploadRequired": false,   "WS_CEMP"
            "isStartState": true, ]
           "isTerminateState": false},
            {
"isStateUpdatable": false,             "actionsaction": ["BACK",
              {
 "nextState": "INWORKFLOW",
              "actionroles": "OPEN",[
                "nextState": "INITIATEDEMPLOYEE",
                "roles": [
CITIZEN",
                 "CITIZENSW_CEMP",
 
                "WS_CEMP"
                ]
 
            }
 
          ]

         },
          {
 
          "sla": null,
 
          "state": "INITIATEDINWORKFLOW",
 
          "applicationStatus": "INWORKFLOW",
 
          "docUploadRequired": false,

           "isStartState": true,
            "isTerminateState": false,
 
          "isStateUpdatable": true,
 
          "actions": [
              {
 
              "action": "SUBMIT",
 
              "nextState": "APPROVED",

               "roles": [
                "EMPLOYEE",
                "CITIZEN",

                 "WSSW_CEMP",
                "WS_CEMP"
    ]          ]
    }        }
    ]      ]
    },    },
      {  {
          "sla": null,
 
          "state": "APPROVED",
            "applicationStatus": "ACTIVE",
 
          "docUploadRequired": false,
 
          "isStartState": false,

           "isTerminateState": true,
            "isStateUpdatable": false,
 
          "actions": null
 
        }
        ]
 
    }
 
  ]
}
 }

Indexer config for water-service:

...

Add mdms configs required for water connection registration and restart mdms service.
Deploy the latest version of ws-services service.
Add water-service and water-services-meter persister yaml path in persister configuration and restart persister service.
Add Role-Action mapping for API’s.
Create businessService (workflow configuration) according for trade water connection, modify water connection
Add ws-service indexer yaml path in indexer service configuration and restart indexer service.

Integration Integration

Integration Scope

This ws-service module is use to manage water service connections against a property in the system.

...

To integrate, host of ws-service module should be overwritten in helm chart.
/ws-services/wc/_createshould be added as the create endpoint for creating water application/connection in the system
/ws-services/wc/_search should be added as the search endpoint .This method handles all requests to search existing records depending on different search criteria
/ws-services/wc/_update should be added as the update endpoint. This method is used to update fields in existing records or to update status of application based on workflow.

Reference Docs

Doc Links

Title	Link
API Swagger Documentation	Swagger Documentation
Water Calculator Service	https://digit-discuss.atlassian.net/l/c/9N49PrrT

API List

Title	Link
/ws-services/wc/_create	https://www.getpostman.com/collections/

b5b7248d1aeacc9431cb
50d596f89ef415595fea
/ws-services/wc/_update
https://www.getpostman.com/collections/
b5b7248d1aeacc9431cb
50d596f89ef415595fea
/ws-services/wc/_search
https://www.getpostman.com/collections/
b5b7248d1aeacc9431cb
50d596f89ef415595fea

(Note: All the API’s are in the same postman collection therefore same link is added in each row)

Versions Compared

Old Version 5

New Version Current

Key

Interaction Diagram:

Role Action Mapping

Integration Integration

Integration Scope

Reference Docs

Doc Links

API List

Title

50d596f89ef415595fea
/ws-services/wc/_update	https://www.getpostman.com/collections/

50d596f89ef415595fea
/ws-services/wc/_search	https://www.getpostman.com/collections/