Overview
Every Service integrated with egov-workflow-v2 service needs to first define the workflow configuration which describes the states in the workflow, the action that can be taken on this states, who all can perform those action, SLA etc. This configuration is created using API’s and is stored in DB. The configuration can be created either state level or tenant level based on the requirements.
...
Deploy latest version of egov-workflow-v2 service
Add Role-Action mapping for BusinessService API’s (preferably add create and update only for SUPERUSER. search can be added for CITIZEN and required employee roles like TL_CEMP etc. )
Overwrite the
egov.wf.statelevel
flag ( true for state level and false for tenant level)Add businessService persister yaml path in persister configuration
Configuration Details
Create the businessService JSON based on product requirement. Following is an sample json of a simple 2 step workflow where an application can be applied by citizen or counter employee and then can be either rejected or approved by the approver.
Code Block { "tenantId": "pb", "businessService": "PGR", "business": "pgr-services", "businessServiceSla": 432000000, "states": [ { "sla": null, "state": null, "applicationStatus": null, "docUploadRequired": false, "isStartState": true, "isTerminateState": false, "isStateUpdatable": true, "actions": [ { "action": "APPLY", "nextState": "PENDINGFORASSIGNMENT", "roles": [ "CITIZEN", "COUNTER_EMPLOYEE" ] } ] }, { "sla": null, "state": "APPLIED", "applicationStatus": "APPLIED", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": false, "actions": [ { "action": "APPROVE", "nextState": "APPROVED", "roles": [ "APPROVER" ] }, { "action": "REJECT", "nextState": "REJECTED", "roles": [ "APPROVER" ] } ] }, { "sla": null, "state": "REJECTED", "applicationStatus": "REJECTED", "isStateUpdatable": false, "docUploadRequired": false, "isStartState": false, "isTerminateState": true }, { "sla": null, "state": "APPROVED", "applicationStatus": "APPROVED", "isStateUpdatable": false, "docUploadRequired": false, "isStartState": false, "isTerminateState": true } ] }
Once the businessService json is created add it in request body of _create API of workflow and call the API to create the workflow.
To update the workflow first search the workflow object using _search API and then make changes in the businessService object and then call _update using the modified search result. (States cannot be removed using _update API as it will leave applications in that state in an invalid state. In such cases first all the applications in that state should be moved forward or backward state and then state should be disabled through DB directly)
...
Steps to Integration
To integrate, host of egov-workflow-v2 should be added overwritten in helm chartschart
/egov-workflow-v2/egov-wf/businessservice/_search should be added as the endpoint for searching workflow configuration . (Other endpoints are not required once workflow configuration is created)
The configuration can be fetched by calling _search API
Reference Docs
Doc Links
Title | Link |
Configuring Workflows For New Product/Entity | |
Workflow Service Documentation (LINK NEEDS TO BE UPDATED) |
API List
Title | Link |
_create | |
_update | |
_search |
...