Workflow Engine
Introduction
The main objective of the Workflow Engine is to maintain master and transactional data for every state of business entity which undergoes a workflow and provides a history of workflow transition. Any entities in the system can be configured to have a workflow using this engine.
Prerequisites
The Business entity has to extend the basic workflow entity (StateAware). Since this is a position based workflow engine, the employees and positions need to be configured beforehand.
Functionality
| Parameter | Description |
|---|---|
| Master states | The System allows to configure the workflow entity and define respective workflow transitional states |
| Transition on Workflow entity | The system provides APIs to move a workflow entity with defined workflow transitional states with business validations and rules |
| Workflow History | The system provides APIs to get the workflow entity history, where one can see who all it has gone for approval and at what stage it was rejected and what all are the comments. |
Configurations and Setup
Do below steps to integrate workflow service for your business entity
- A business entity has to extend StateAware from workflow service
- Define a workflow type master (eg_wf_types). Some of the fields explained below
- module: The module that a business entity belongs to
- typefqn: A full classpath of your business entity, this will help the inbox render service to dynamically get the object
- displayname: Give a name that appears in the inbox for your business entity entry.
- link: Link to open a page when you open from inbox
- Define master workflow states for your business entity in the workflow matrix master (eg_wf_matrix). Some of the fields explained below
- Department: The departments to select by used to pick the next employee
- objecttype: The business entity class name what you have given in workflow type master
- nextdesignation: The designation of the employee to whom it has to be forwarded
- validactions: List of the actions can be performed on a business entity, Eg: Approve, Reject.
- nextstate: The next state of the business entity.
- Start wofkflow APIs. The basic APIs in workflow service are start, transition and end