Workflow Engine 22.1.0

August 18, 2026

Overview

Workflow Engine 22.1.0 is a minor feature and maintenance release focused on actor expression support, Approval Plugin history storage options, published migration assets, stronger Workflow Engine Web API tenant isolation, and multiple Basic Plugin correctness fixes.

Why update

• Use expressions in actor values and optionally store technical names in Approval Plugin history instead of localized display values.
• Get published database creation and migration scripts together with richer migrator version metadata for deployment automation and auditability.
• Improve Workflow Engine Web API tenant safety by restricting readiness output to authorized tenants, making duplicate permission evaluation deterministic, and preventing tenant ID reuse after failed shutdown.
• Fix Basic Plugin behaviors that could misroute transitions, return inconsistent comparison results, or fail with NullReferenceException during parameter checks and SetParameter execution.

Key features

• Actor values can now use expressions.
• Approval Plugin can store technical names in approval history when UseLocalizedNamesInApprovalHistory = false.
• Migrator APIs now expose both MigrationVersion and Workflow Engine product version.
• Database creation and migration scripts are now published for release consumption and deployment automation.
• Workflow Engine Web API and Basic Plugin behaviors are more predictable in multi-tenant authorization, parameter comparison, and parameter assignment scenarios.

Changelog

Update instructions

• All packages: update Workflow Engine packages to version 22.1.0.
• If you use Approval Plugin and want approval history to keep stable technical names instead of localized display values, set UseLocalizedNamesInApprovalHistory = false. The default behavior remains unchanged.
• If you use BasicPlugin CheckParameter with NotEqual or NotIn as an implicit missing-parameter check, review those schemes. Starting in 22.1.0, missing or null parameters return false for all compare types.
• If you use BasicPlugin SetParameter to save an empty string, pass the explicit C# string literal \"\". Empty, missing, or null Value entries are now rejected instead of failing later with NullReferenceException.
• If your deployment process uses reviewed SQL assets or external automation, you can now consume the published database creation and migration scripts shipped with the release. Existing migrator-based upgrade flows remain supported.
• If you still reference the obsolete downloadschemebpmn command in internal documentation or custom integrations, remove those references. It is no longer documented as a supported Workflow Designer operation.
• No other package-specific manual migration steps are required for this release.

Features

• Core: added support for using expressions in actor values.
• Approval Plugin: added the option to store technical names in approval history instead of localized values through UseLocalizedNamesInApprovalHistory = false.
• Migrator: extended the public API to expose both MigrationVersion and Workflow Engine product version.

Enhancements

• Distribution: published the database creation and migration scripts for supported providers as release assets.
• Documentation and Designer-related references: removed obsolete downloadschemebpmn mentions so current documentation reflects supported BPMN-related behavior.

Bug fixes

• BasicPlugin: fixed StartAndEndWith and NotStartAndEndWith so they evaluate both StartsWith(...) and EndsWith(...) instead of calling StartsWith(...) twice.
• BasicPlugin: fixed CheckParameter so a missing or null parameter returns false for every compare type and no longer throws exceptions for string-based comparisons.
• BasicPlugin: fixed CheckParameter for implicit persistent string parameters restored from persistence, so Equal and NotEqual compare the logical value after reload instead of the serialized JSON representation.
• BasicPlugin: fixed SetParameter validation so empty, missing, or null Value entries produce a clear validation error instead of a runtime NullReferenceException.
• Designer: fixed custom action template editing so action parameter forms no longer show Activity Name and State fields that belong to activity editing.
• Workflow Engine Web API: fixed /readiness so multi-tenant requests no longer expose readiness data for unauthorized tenants.
• Workflow Engine Web API: fixed authorization inconsistencies caused by duplicate permission rules whose outcome previously depended on rule order.
• Workflow Engine Web API: fixed tenant unregister behavior so a failed shutdown does not release the reservation and allow conflicting re-registration over an uncleared runtime or provider.
• SQLite provider: fixed the .NET 10 dependency alignment by correcting the Entity Framework Core package version used by OptimaJet.Workflow.SQLite.

Resources

• Database migrations guide: Database versioning.
• Workflow Engine Web API multitenancy: Multitenancy.
• Workflow Engine Web API authorization: Security services.
• Approval Plugin documentation: Approval Plugin.
• Basic Plugin documentation: Basic Plugin.