WorkflowEngine.NETCore-Core 23.0.0

WorkflowEngine.NETCore-Core

WorkflowEngine.NETCore-Core is the core runtime package for Workflow Engine by Optimajet, an embeddable workflow engine for .NET and C# applications. It supplies WorkflowRuntime, the scheme model and builder, runtime contracts, timers, commands, rules and process execution. Add one persistence provider package for your database.

Get Workflow Engine Free · Run the quick start · Product page · Documentation · Compare products

Install

Create a .NET 10 console application, then install the core package and one provider. SQLite keeps this example self-contained and is intended for evaluation.

dotnet new console -n WorkflowQuickstart --framework net10.0
cd WorkflowQuickstart
dotnet add package WorkflowEngine.NETCore-Core
dotnet add package WorkflowEngine.NETCore-ProviderForSQLite

The core package targets .NET Standard 2.0. Workflow Engine supports .NET 8, .NET 10 and .NET Framework 4.7.2, with package-specific exceptions for Oracle and SQLite.

Run a workflow

This console example creates an Approval scheme, starts one process, and moves it from Draft to Approved with Workflow Engine on .NET 10.

using System.Xml.Linq;
using OptimaJet.Workflow.Core.Builder;
using OptimaJet.Workflow.Core.Model;
using OptimaJet.Workflow.Core.Model.Builder;
using OptimaJet.Workflow.Core.Parser;
using OptimaJet.Workflow.Core.Runtime;
using OptimaJet.Workflow.Migrator;
using OptimaJet.Workflow.SQLite;

// Configure a Workflow Runtime with SQLite as its database
var provider = new SqliteProvider("Data Source=workflow.db");
var runtime = new WorkflowRuntime()
    .WithBuilder(new WorkflowBuilder<XElement>(provider, new XmlWorkflowParser(), provider).WithDefaultCache())
    .WithPersistenceProvider(provider)
    .RunMigrations()
    .Start();

try
{
    // A scheme in C#: Draft -> Review -> Approved, moved by two commands
    var scheme = ProcessDefinitionBuilder.Create("Approval");
    scheme.CreateActivity("Draft").Initial().Ref(out ActivityDefinition draft);
    scheme.CreateActivity("Review").Ref(out ActivityDefinition review);
    scheme.CreateActivity("Approved").Final().Ref(out ActivityDefinition approved);
    scheme.CreateCommand("Submit").Ref(out CommandDefinition submit);
    scheme.CreateCommand("Approve").Ref(out CommandDefinition approve);
    scheme.CreateTransition("Submit", draft, review).TriggeredByCommand(submit);
    scheme.CreateTransition("Approve", review, approved).TriggeredByCommand(approve);
    await runtime.Builder.SaveProcessSchemeAsync("Approval", scheme.ProcessDefinition);

    // Start a process and move it with the commands available to a user
    var processId = Guid.NewGuid();
    await runtime.CreateInstanceAsync("Approval", processId);
    foreach (var name in new[] { "Submit", "Approve" })
    {
        var commands = await runtime.GetAvailableCommandsAsync(processId, "alice");
        await runtime.ExecuteCommandAsync(commands.First(c => c.CommandName == name), "alice", "alice");
        Console.WriteLine($"{name} -> {await runtime.GetCurrentActivityNameAsync(processId)}");
    }
}
finally
{
    await runtime.ShutdownAsync();
}

dotnet run prints:

Submit -> Review
Approve -> Approved

The complete quick start also covers ASP.NET Core and Workflow Designer.

Choose a persistence provider

Every runtime needs a database. SQL providers apply their schema through RunMigrations(). The MongoDB provider creates its collections and indexes at runtime.

Products and licensing

The same core package runs Workflow Engine Free, Workflow Engine and Workflow Engine NEO. A license key changes the available limits and capabilities; application code and stored schemes stay on the same runtime.

• Workflow Engine Free needs no license key. It covers personal use and internal commercial use with attribution, up to 10 workflow definitions (schemes) and 4 execution threads. Activities, transitions and commands are unrestricted, and the full Workflow Designer is included.
• Workflow Engine and Workflow Engine NEO require a paid license for their licensed use. See Compare products for the product and edition boundaries.
• A 30-day trial key enables the licensed capabilities for evaluation.

Workflow Engine is commercial software. Read the EULA before distributing or operating it outside the Workflow Engine Free grant.

Releases and support

• Breaking changes and migrations: release notes
• C# types and methods: API reference
• Technical questions: support@optimajet.com
• Editions and evaluation: hello@optimajet.com or book a demo

Source repository and issues