Workflow Engine 20.0.0

October 30, 2025

Overview

Workflow Engine 20.0.0 introduced the Form Plugin, significant Web API updates, and a Vue 3 Designer upgrade, together with several breaking changes. Please use version 20.0.3 instead of version 20.0.0.

Why update

• Add native integration with Form Engine through the new Form Plugin.
• Use Web API improvements: the new workflow-api.designer endpoint and updated tenant registration.
• Reduce upgrade risk for upcoming major versions by moving away from obsolete APIs in Core, Web API, and plugins.

Key features

• Introduced the Form Plugin with a ready-to-use API and UI integration with Form Engine.
• Added workflow-api.designer endpoint for Workflow Designer integration.
• Added support for registering external WorkflowRuntime instances as Web API tenants.
• Added a ConnectionString property to IPersistenceProvider.

Changelog

Update instructions

• Do not stay on 20.0.0 in production.
• Use this migration checklist to apply only the relevant changes for your setup.
• If you use custom Vue templates in Designer, migrate them from Vue 2.6.14 to Vue 3.5.22. See Migration to Vue 3.
• If you use Web API endpoint registration with UseWorkflowApi, replace it with UseRouting and MapWorkflowApi.
• If you use Web API service registration with AddWorkflowApi, replace it with AddWorkflowApiCore, AddWorkflowApiSecurity, and AddWorkflowRuntime.
• If you use OptimaJet.Workflow.Api.Extensions, rename: AddWorkflowEngineRuntime -> AddWorkflowRuntime, AddWorkflowEngineRuntimeTenants -> AddWorkflowTenants, GetHttpContextTenantId -> GetHttpContextWorkflowTenantId, GetHttpContextTenant -> GetHttpContextWorkflowTenant.
• If you use OptimaJet.Workflow.Api, rename: OperationId -> WorkflowApiOperationId, IWorkflowApiTenantRegistry -> IWorkflowTenantRegistry, IWorkflowApiTenant -> IWorkflowTenant (Runtime -> WorkflowRuntime), WorkflowApiTenant -> WorkflowTenant (Runtime -> WorkflowRuntime).
• If you use OptimaJet.Workflow.Api.Options, rename: WorkflowApiDataProviderOptions -> DataProviderCreationOptions, RuntimeCreationOptions -> WorkflowRuntimeCreationOptions, WorkflowEngineTenantCreationOptions -> WorkflowTenantCreationOptions ( DataProviderId -> PersistenceProviderId, RuntimeCreationOptions -> WorkflowRuntimeCreationOptions, WorkflowApiDataProviderOptions -> DataProviderCreationOptions).
• If you use the MongoDB provider, set ConnectionString during provider initialization.
• If you use features marked as obsolete, plan replacement before the next major release: SchemaDefinigParameter, timer-management methods, schema defining parameters for schema generation, Assignment Plugin, Telegram Plugin, Slack Plugin, Nexmo Plugin, Twilio Plugin.
• After applying the relevant migration changes, update directly to 20.0.3 or later.

Features

• Introducing the Form Plugin - a solution that provides a ready-to-use API and UI to connect Workflow Engine with Form Engine. It lets you render and submit workflow-bound forms, validate and persist data, and execute available process commands.
• Added a new Web API operation workflow-api.designer, a ready-to-use endpoint for Workflow Designer.
• Added support for System.Text.Json.JsonElement in DynamicParameter.
• Added support for registering external WorkflowRuntime instances as Web API tenants.
• Added a ConnectionString property to IPersistenceProvider.

Enhancements

• Optimized WorkflowRuntime.ExecuteCommandAsync.
• Improved Web API documentation and added OpenAPI specification.

Bug fixes

• Fixed a bug in BasicPlugin where an exception was thrown during pre-execution in the IsApproveComplete condition.
• Fixed a Web API issue where DisableSecurity behaved incorrectly.
• Fixed a Web API issue where single-tenant mode did not work without an explicit TenantId.

Resources

• Form Plugin documentation: Forms.
• Vue migration guide: Migration to Vue 3.
• Web API specification: OpenAPI.

Security

• Upgraded Designer from Vue 2 to Vue 3 to address known vulnerabilities.