KMTS.WorkflowEngine.Generator 1.4.0-singletable.3

KMTS.WorkflowEngine

A generic, database-driven workflow engine for .NET applications.

Features

• Database-Driven Configuration: All workflow definitions, stages, actions, and transitions are stored in the database
• Parallel Approvals: Support for multi-approver stages with configurable consensus policies
• ABAC Policies: Attribute-Based Access Control for fine-grained authorization
• Lifecycle Hooks: Extensible hooks for pre/post action and stage transition events
• Pluggable Architecture: Register custom action executors, entity handlers, rules, and conditions
• Optimistic Concurrency: Built-in race condition protection with RowVersion
• Audit Trail: Comprehensive workflow history with entity snapshots

Installation

dotnet add package KMTS.WorkflowEngine.Domain
dotnet add package KMTS.WorkflowEngine.Application
dotnet add package KMTS.WorkflowEngine.Infrastructure
dotnet add package KMTS.WorkflowEngine.Presentation

Quick Start

1. Register Services

// In Program.cs
builder.Services.AddWorkflowEngine(options =>
{
    // Scan for rules in your module assemblies
    options.RuleAssemblies.Add(typeof(MyActionExecutor).Assembly);
});

// Map workflow endpoints
app.MapWorkflowEngineEndpoints();

2. Implement Your Entity

public class Finding : Entity, IWorkflowEntity
{
    public int CurrentStageNumber { get; private set; }
    public string? AssignedToUserId { get; private set; }
    public string? AssignedToUserName { get; private set; }
    public string CreatedByUserId { get; private set; }

    public void TransitionToStage(int stageNumber, string userId)
    {
        CurrentStageNumber = stageNumber;
    }

    public void AssignTo(string userId, string userName)
    {
        AssignedToUserId = userId;
        AssignedToUserName = userName;
    }
}

3. Implement Action Executor

[WorkflowActionExecutor("FINDING", Priority = 100)]
public class FindingActionExecutor : IWorkflowActionExecutor
{
    public string EntityType => "FINDING";

    public Task<Result> ExecuteAsync(
        IWorkflowEntity entity,
        string actionCode,
        string userId,
        Dictionary<string, object> additionalData,
        CancellationToken ct)
    {
        var finding = (Finding)entity;

        return actionCode switch
        {
            "APPROVE" => Task.FromResult(finding.Approve(userId)),
            "REJECT" => Task.FromResult(finding.Reject(userId, GetComments(additionalData))),
            _ => Task.FromResult(Result.Failure(Error.Validation("Unknown action")))
        };
    }
}

4. Configure in Database

Insert workflow configuration into the database tables:

• WorkflowDefinitions
• WorkflowStages
• WorkflowStageActions
• WorkflowTransitions
• WorkflowRoles

Architecture

KMTS.WorkflowEngine/
├── Domain/           # Entities, interfaces, enums
├── Application/      # Commands, queries, services
├── Infrastructure/   # EF Core, registries, resolvers
└── Presentation/     # Endpoints, DI extensions

License

MIT License