Ram Narayan Balaji 9cc0441da2
Feat# Implementation of Custom Workflows (#23023)
* Draft Implementation of Custom Workflows

* Multiple Entities in the Same Trigger for Workflow, along with draft implementation of signal id

* Improved User Approval Task and Impl

* Custom Workflows - Draft Implementation 2, improved periodic batch entity filter and other improvements

* feat(governance): Implement transactional custom workflows - improved

This commit introduces a robust, transactional, and extensible framework for custom governance workflows in OpenMetadata.

Key features and improvements include:

Transactional Workflow Management: A new WorkflowTransactionManager ensures atomic operations for creating, updating, and deleting workflow definitions, maintaining consistency between the OpenMetadata database and the Flowable engine.

Safe ID Encoding: Implemented a WorkflowIdEncoder to generate safe, Base64-encoded, and collision-resistant IDs for Flowable processes, preventing errors from ID truncation.

Rollback and Deprecation Tasks:

Added RollbackEntityTask to revert entities to their last approved state.

Introduced DeprecateStaleEntityTask for automated lifecycle management of stale assets.

Enhanced Workflow Engine:

Improved WorkflowHandler to validate workflow definitions before deployment.

Added new custom functions to the rule engine for checking entity update timestamps and calculating field completeness scores.

CI/CD and Build Improvements:

Updated the CI Dockerfile with a multi-stage build and refined dependency installation.

Modified POM files to include necessary dependencies for new features.

* Adding DataCompleteness Task Node, Flowable Debug logs

* Transaction handling for Custom Workflow - Initial Draft

* add new tasks to node definition interface

* Update generated TypeScript types

* Draft Implementation of Multi Reviewer Approval Task with Migration

* Update generated TypeScript types

* Transaction handling fix, id truncation fix by migration, feed repo fix for multi reviewer pattern, copilot comments

* Update generated TypeScript types

* Fixed Multi Reviewer approval to take consideration of the namespaced variables, Fixed RollBackEntity task to follow subprocess like other automated tasks, copilot nitpicks

* Remove conditionalSetEntityAttributes as it is not needed anymore

* Update generated TypeScript types

* Completely remove the setConditionalAttributes to fix compilation errors

* Removed the comments in the schemaChanges

* Created a new Task called CreateDetailedApprovalTaskImpl, Fixed RollBackEntityTask to roll back to either Approved or Rejected state, use namespaced variables, Updated the workflow handler to resolve the tasks and remove them from the user who has approved the task in the feed during multi reviewer approval, TransactionManager updated to keep Transactions in place, Improve the Validation Node input in the Mainworkflow java to handle proper graph traversal, Find Proper Termination Message for the two user events that are conflicting, Include Message in the request approval thread task for proper messages

* Update generated TypeScript types

* Rendering of messages in task thread

* Fix PeriodicBatchEntityTriggerTask to separate workflows based on entities Draft, Fix: SetEntityAttributes Impl to handle multiple fields, Fix: DataCompletenessTask Draft

* Fix DataCompletenessTask BoundaryEvent in Flowable

* Introduced Wf Deployment Strategy for transaction Handling, Improved user tasks for better termination event naming, fix periodic batch entity trigger to fetch the entity instead of all the entities in the trigger, Migrated GlossaryApprovalWorkflow.json with new nodes and edges, Fixed test cases and some edge cases

* Update generated TypeScript types

* Added performTasks for TagRepository and DataProductRepository, Removed test api, removed unnecessary change from workflow json, improved DataCompletenessImpl, Improved CreateDetailedApprovalTaskImpl to show what updated and not updated in the thread response

* Remove Entity Certification and Entity Status tasks and make use of generic set entity attribute task

* Update generated TypeScript types

* Fix the compilation issues!

* Remove setCertification and setEntityAttributes from createWorkflowDefinition

* Test cases for custom workflows related to glossaryTermApprovalWorkflow

* Test cases for custom workflows

* Changed info to debug logs

* Update generated TypeScript types

* DetailedUserApprovalTask changed to reviewChange task, Have validations for workflows where user approval tasks can only be available for entities that support reviewers

* Fix compilation issues and mvn spotless apply

* Update generated TypeScript types

* Remove Extra assignees from user tasks

* Update generated TypeScript types

* Replace Tags/GlossaryTerms during Mutual Exclusivity and Append when there is no Mutual Exclusivity

* Workflow Transaction Manager to handle authorization as part of its functionality, Added Validation for workflows using /validate endpoint

* Increase the Flowable's polling time to 60 seconds to poll timer and async jobs table

* Update generated TypeScript types

* Enum for UserTask Termination Messages, Removed WorkflowUtils to use WorkflowHandler's terminateDuplicate Instances, Approval and rejecters list in the variables, using namespaced variables for updatedBy

* Reverted the enum for userTaskType for now

* Added new tests for dataContract, dataProduct and Tag for user approval tasks

* Glossary Approval Workflow changed to handle jsonLogic according to UI expectations

* Added a new Task type for change description tasks to review and suggest the changes, Added checkUpdatedByReviewer incase of perfom tasks, increase wf test timeout

* Update generated TypeScript types

* TaskWorkflow constructor public to be used by Collate Repo

* AutoApproveServiceTaskImpl incase the assignees are not there for the userTask with ExlusiveGateway builder with hasAssignees

* Fix Compilation Issues - Upgrade of deps to lang3

* ExclusiveGatewayBuilder set exclusive as true, and other minor changes for test and approval tasks

* Added a different wait mechanism for user tasks in WorkflowDefinitionResourceTest.java

* Combined UserApprovalTask and ChangeReviewTask into one to handle suggestions in the same task!

* Update generated TypeScript types

* Test Case Approval Workflow, Removing orphaned changeReviewTask, Test case fix and new test cases

* Update generated TypeScript types

* Treat empty strings, arrays as missing by default

* Update generated TypeScript types

* fix compilation issues by changing the schema properly

* Remove Stale ChangeReview Task

* Update generated TypeScript types

* Enhanced User Approval task to show changed fields along with what changed and the task resolve function as well

* Update generated TypeScript types

* Add Knowledge center page to workflows event consumer, remove legacy backward compatibility for triggers, lenient validations for workflows when there are no nodes

* EntitySpecific Filters for EventBased Trigger, Removing Backward Compatibility logic for filters, Removed unnecessary comments and execution variables, Handle Structured task resolver for dataProduct, dataContract, tag and testCase, Modified GlossaryApprovalWorkflow.json and improved the MigrationUtil

* Update generated TypeScript types

* Bring back entitycertification and glosarystatus task for backward compatibility

* Update generated TypeScript types

* Filter is a map, entity specific filters are stringified, have certification and glossary status tasks in nodeinterface

* Merge Main

* Remove Suggestions for RequestApproval

* Update generated TypeScript types

* Remove Old Deployments of Periodic Batch Entity Trigger and use hiphen to trigger to avoid accidental triggering

* Resolve Merge conflicts, Java Checkstyle

* Update generated TypeScript types

* Fix Migrations

* Added alter table queries in 1.6.0 to avoid cached plan queries in flowable

* Increase timeout in workflow definition resource test

* Increase polling in workflow definition resource test

* Fix java Checkstyle

* comment the flaky test

* COmmented out Flaky Test Cases, fixed a bug on team reviewers

* Resolve java checkstyle after resolving conflicts

* add updated at field in json logic for glossary

* update fields

* add version field

* Update the rule config of new term node with "and" and update the migration as well

* add equal not equal op

* Delete the trigger workflows using like condition

* Defensive Fallback for multiple task instances created by race condition, Terminate duplicate instances of main workflows

* reverting operators

* Approval Capabilities for Metrics

* Update generated TypeScript types

* Move Migrations to 1.10.1 from 1.10.0

* Removed the extra spaces in Migration 1.10

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: karanh37 <karanh37@gmail.com>
2025-10-08 18:57:44 +05:30
..
2023-09-22 09:45:00 +02:00
2024-05-07 22:07:25 +05:30
2024-05-07 22:07:25 +05:30
2024-04-16 18:51:03 +05:30
2024-06-12 10:40:05 +05:30
2024-07-19 12:16:53 +05:30
2024-08-06 18:41:37 +05:30
2024-09-30 23:39:27 +05:30
2025-01-28 19:22:33 +05:30
2025-07-31 06:38:21 +02:00
2025-07-31 06:38:21 +02:00
2025-07-31 06:38:21 +02:00
2025-10-06 18:56:11 +05:30