Configuring Workflows For New Product/Entity

Overview

Workflow is defined as a sequence of tasks that has to be performed on an application/Entity to process it. The egov-workflow-v2 is a workflow engine which helps in performing this operations seamlessly using a predefined configuration. We will discuss how to create this configuration for a new product in this document.

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

• egov-workflow-v2 service is up and running

• Role-Action mapping are added for businessService API’s 

Key Functionalities

• Create and modify workflow configuration according to the product requirements

• Configure State level as well BusinessService level SLA to efficiently track progress of the application

• Control access to perform actions through configuration

Deployment Details

1. Deploy latest version of egov-workflow-v2 service

2. Add businessService persister yaml path in persister configuration

3. Add Role-Action mapping for BusinessService API’s

4. Overwrite the egov.wf.statelevel flag ( true for state level and false for tenant level)

Configuration Details

1. The Workflow configuration has 3 level of hierarchy:
   a. BusinessService
   b. State
   c. Action
   The top level object is BusinessService, it contains fields describing the workflow and list of States that are part of the workflow. The businessService can be defined at tenant level like pb.amritsar or at state level like pb. All objects maintains an audit sub object which keeps track of who is creating and updating and the time of it

   { "tenantId": "pb.amritsar", "businessService": "PGR", "business": "pgr-services", "businessServiceSla": 432000000, "states": [...] }

   
   Each State object is a valid status for the application. The State object contains the information of the state and what actions can be performed on it.
   
   

   { "sla": 36000000, "state": "PENDINGFORASSIGNMENT", "applicationStatus": "PENDINGFORASSIGNMENT", "docUploadRequired": false, "isStartState": false, "isTerminateState": false, "isStateUpdatable": false, "actions": [...] }

   
   The action object is the last object in hierarchy, it defines the name of the action and the roles that can perform the action.
   
   

   { "action": "ASSIGN", "roles": [ "GRO", "DGRO" ], "nextState": "PENDINGATLME", }

   
   
   

2. The workflow should always start from null state as the service treats new applications as having null as the initial state. eg:

3. In action object whatever nextState is defined, the application will be sent to that state. It can be to another forward state or even some backward state from where the application have already passed
   ( generally such actions are named SENDBACK)

4. SENDBACKTOCITIZEN is a special keyword for action name. This action sends back the application to citizen’s inbox for him to take action. A new State should be created on which Citizen can take action and should be the nextState of this action. While calling this action from module assignes should be enriched by the module with the uuids of the owners of the application

Integration

 For integration related steps please refer to the document ' Setting Up Workflows'  in the Reference Docs

Reference Docs

Doc Links

API List

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