Workflow Engine 20.0.1

Designer

• Fixed the behavior of the Elements panel in the Designer, which experienced issues after the upgrade to Vue 3.

Workflow Engine 20.0.0

Form Plugin

Introducing the Form Plugin — a solution that provides a ready-to-use API and UI to connect Workflow Engine with the Form Engine. It lets you render and submit workflow-bound forms, validate and persist data, and execute available process commands. Learn more in the Forms documentation.

Core

• Several features are marked as Obsolete and will be removed in the next major release. The general list includes:
  • Schema defining parameters for schema generation
  • Some timer-management methods
  • Schema objects creation methods bypassing builders
  • Assignment Plugin
  • Telegram Plugin
  • Slack Plugin
  • Nexmo Plugin
  • Twilio Plugin
• Optimized the WorkflowRuntime.ExecuteCommandAsync method.
• Fixed a bug in BasicPlugin where an exception was thrown during pre-execution in the IsApproveComplete condition.
• Added support for System.Text.Json.JsonElement in DynamicParameter.
• Added the ConnectionString property to IPersistenceProvider.
• [Breaking changes] The MongoDB provider now requires a ConnectionString during initialization.

Designer

• [Breaking changes] Updated Vue from 2.6.14 to 3.5.22 to address vulnerabilities. If you use custom Vue templates, you must update them to work with Vue 3 version. See the migration guide for details.

Web API

• Added a new workflow-api.designer operation — a ready-to-use endpoint for Workflow Designer.
• Added support for registering external WorkflowRuntime instances as tenants via AddWorkfowTenantProvider.
• Fixed an issue where DisableSecurity behaved incorrectly.
• Fixed an issue where single-tenant mode did not work without an explicit TenantId.
• Improved documentation and added an OpenAPI specification for all endpoints.
• [Breaking changes] Removed UseWorkflowApi. Use UseRouting and MapWorkflowApi to register endpoints.
• [Breaking changes] Removed AddWorkflowApi. Use AddWorkflowApiCore, AddWorkflowApiSecurity, and AddWorkflowRuntime to register services.
• [Breaking changes] Renamed several methods and types:
  • OptimaJet.Workflow.Api.Extensions:
    • AddWorkflowEngineRuntime → AddWorkflowRuntime
    • AddWorkflowEngineRuntimeTenants → AddWorkflowTenants
    • GetHttpContextTenantId → GetHttpContextWorkflowTenantId
    • GetHttpContextTenant → GetHttpContextWorkflowTenant
  • OptimaJet.Workflow.Api:
    • OperationId → WorkflowApiOperationId
    • IWorkflowApiTenantRegistry → IWorkflowTenantRegistry
    • IWorkflowApiTenant → IWorkflowTenant
      • Runtime → WorkflowRuntime
    • WorkflowApiTenant → WorkflowTenant
      • Runtime → WorkflowRuntime
  • OptimaJet.Workflow.Api.Options:
    • WorkflowApiDataProviderOptions → DataProviderCreationOptions
    • RuntimeCreationOptions → WorkflowRuntimeCreationOptions
    • WorkflowEngineTenantCreationOptions → WorkflowTenantCreationOptions
      • DataProviderId → PersistenceProviderId
      • RuntimeCreationOptions → WorkflowRuntimeCreationOptions
      • WorkflowApiDataProviderOptions → DataProviderCreationOptions

Workflow Engine 19.0.0

Core

• Added unique identifiers by database type to IPersistenceProvider.

Workflow Engine Web API

• [Major feature] Introducing the RPC API. Remotely manage Workflow Engine Runtime instances in single-tenant or multi-tenant mode.
  See the documentation or check out our GitHub repository.

Breaking Changes

Breaking changes affect only users of the Workflow Engine Web API.

• To start the API, you must register at least one tenant via AddWorkflowEngineRuntimeTenants,
  or configure single-tenant mode via AddWorkflowEngineRuntime or AddWorkflowApi.
• Data component settings are now provided through WorkflowApiDataProviderOptions inside WorkflowEngineTenantCreationOptions.
• The WorkflowApiSetupOptions class has been renamed to WorkflowApiOptionsSetup.

Workflow Engine 18.1.0

Designer

• Updated internal functionality related to forms.

Samples

• Removed legacy .NET Framework samples.

Workflow Engine 18.0.0

Breaking Changes

• The Angular designer package and sample have been updated to Angular 20.

Workflow Engine 17.3.0

Core

• Added logging for OptimaJet.Workflow.Migrator via WorkflowRuntime. To use it, add the logger to the runtime before adding the migrator.
• Added Code Actions Builder to ProcessDefinitionBuilder.

Designer

• Fixed issues in printable mode in Designer.
• Updated dependencies in Designer:
  • form-data from 4.0.0 to 4.0.4;
  • compression from 1.7.4 to 1.8.1;
  • on-headers from 1.0.2 to 1.1.0;
• Updated dependencies in workflow-designer-react:
  • brace-expansion from 1.1.11 to 1.1.12;
• Updated Webpack and related packages in Designer dev dependencies:
  • webpack from 5.50.0 to 5.101.0;
  • webpack-cli from 4.8.0 to 6.0.1;
  • webpack-dev-server from 4.8.1 to 5.2.2;

Providers

• Updated SQL scripts in WorkflowEngine.NETCore-ProviderForMySQL for the Migrator to enhance compatibility with MariaDB.

Workflow Engine 17.2.0

Core

• Added a persist parameter to the SetActivityWithExecutionAsync method. You can now pass implicit parameters with the persistence storage type.
• Introduced the OverrideRuleProvider method in the base plugin to allow overriding the plugin’s rule provider implementation.
• Added the GetApproverIdentityId delegate to the Parallel Approvers mechanism in the base plugin. This allows customizing how the IdentityId is retrieved based on the FillApproversUsers action parameter.
• Added the RequiredApprovalsNumber setting to the Parallel Approvers mechanism in the base plugin. This allows specifying the number of approvals required to complete parallel approval.
• Fixed a NullReferenceException caused by the FillApproversRoles action in the Parallel Approvers mechanism of the base plugin.

Providers

• PostgreSQL now supports creating a version history table in a schema other than public when using automatic migrations.
  To do this, specify the desired schema in the provider arguments.

Designer

• Fixed an issue where data in custom activities was not displayed when opening the form.

Workflow Engine 17.1.0

Providers

• Fixed an issue in PostgreSQL migrations where objects were created in the wrong schema when a Search Path was specified.
• Replaced the MongoDB driver from MongoDB.Driver.signed 2.14.1 with MongoDB.Driver 2.30.0.
• Replaced the MySQL driver from MySql.Data 8.0.28 with MySqlConnector 2.4.0.
• Updated dependencies in the OptimaJet.Workflow.Core package:
  • System.Text.RegularExpressions to version 4.3.1
• Updated dependencies in the OptimaJet.Workflow.MSSQL and OptimaJet.Workflow.Migrator packages:
  • Microsoft.IdentityModel.JsonWebTokens to version 8.10.0
  • System.IdentityModel.Tokens.Jwt to version 8.10.0
  • System.Runtime.Caching to version 8.0.1
  • Microsoft.Identity.Client to version 4.72.1
  • Azure.Identity to version 1.14.0
• Updated dependencies in the OptimaJet.Workflow.FilesPlugin package:
  • System.Net.Security to version 4.3.2
• Updated dependencies in the OptimaJet.Workflow.NexmoPlugin package:
  • System.Text.Encodings.Web to version 8.0.0
• Updated dependencies in the OptimaJet.Workflow.SQLite package:
  • Microsoft.Data.Sqlite to version 8.0.16
  • System.Text.Json to version 8.0.5
• Updated dependencies in the OptimaJet.Workflow.TwilloPlugin packages:
  • Microsoft.IdentityModel.JsonWebTokens to version 8.10.0
  • System.IdentityModel.Tokens.Jwt to version 8.10.0

Designer

• Fixed a bug where the Boolean type was missing from the list of available parameter types.
• Updated dependencies:
  • http-proxy-middleware from version 2.0.6 to 2.0.9.
  • @babel/helpers from version 7.23.8 to 7.27.0

Workflow API

• DataEngine has been updated from version 1.1.1 to 1.2.0.
  For more details, see the release notes.
• Updated MongoDB.Driver from version 2.24.0 to 2.30.0.
• Updated dependencies in the OptimaJet.Workflow.Api.Mssql package:
  • System.Text.Json to version 8.0.5.

Workflow Engine 17.0.0

Plugins

• Fixed an issue where the HttpRequestActivity handler not passed to HTTPClient.

Designer

• The Angular designer package and sample have been updated to Angular 19.
• Fixed a bug that caused the designer to load incorrectly in Strict Mode of React when the schema did not exist.
• The axios dependency has been upgraded from version 1.7.4 to 1.8.2.
• The @babel/helpers dependency has been upgraded from version 7.15.4 to 7.26.10.

Workflow Engine 16.4.0

Core

• Added parameterless constructor for BpmnPlugin.
• Added localization support in ProcessDefinitionBuilder.

Designer

• Updated @microsoft/signalr dependency from 8.0.0 to 8.0.7.
• Fixed issue with CodeActionsButton not working when adding annotations in transition expert mode.
• Fixed parameter editing window for ApprovalPlugin transitions.