WorkflowEngine.NET

Core

• Fixed an issue where subprocess parameter values were being overwritten by default values of parameters defined in the schema. Now, parameters are no longer initialized with default values when creating a subprocess. If you previously relied on this behavior, you will need to update your existing schemas or set the WorkflowRuntimeSettings.ObsoleteSubprocessParametersInitializationBehavior option totrue. This setting will only affect parameters that are not copied when using the CopySpecified, IgnoreSpecified ot IgnoreAllpolicy. When using the CopyAll policy, parameters will be copied from the parent process, making initialization unnecessary. Overwriting these parameters was a bug and not considered as breaking changes.
• The GetProcessInstancesAsync method for the MongoDB provider has been fixed. Sorting and paging now work correctly.
• The GetSchemesAsync method has been corrected, and tag lists are now generated properly. Sorting and paging for the MongoDB provider have also been fixed.
• The GetTopTimersToExecuteAsync method now throws an exception when the top argument is less than 0. The handling of this argument for the MongoDB provider has also been fixed.

Designer

• webpack has been updated to version 5.94.0.
• axios has been updated to version 1.7.4.

Workflow Engine Web API

Introducing a new product in the Workflow Engine ecosystem: the Workflow Engine Web API. This is a library for the ASP.NET framework that allows you to integrate a pre-built Web API into your application for managing data and processes within Workflow Engine instances. This module is easy to integrate and highly customizable, eliminating the need for routine development work to integrate Workflow Engine into your web ecosystem.

Key features:

1. RESTful Data API: Safely interact with the Workflow Engine database without the risk of internal process disruptions.
2. RPC API (Coming soon…): Remotely manage the Workflow Engine Runtime instance.
3. Permission-based Security: Fine-tune access to each API endpoint and generate claims for your users.

For more information, refer to the documentation.

Unique Indexes

• Unique indexes have been added to all database providers:
  • WorkflowGlobalParameter: Type, Name;
  • WorkflowInbox: ProcessId, IdentityId;
  • WorkflowProcessInstancePersistence: ProcessId, ParameterName;
  • WorkflowProcessTimer: ProcessId, Name.
• In MongoDB, the index for the WorkflowScheme collection (Code) is now unique.

You can update the data schema using the built-in migration mechanism for SQL databases, or manually run the update_14.0.0.js script for MongoDB. You may also choose not to use these indexes or selectively apply some of them as needed.

Potential Breaking Changes

• For MS SQL Server only: To add indexes, the field lengths for WorkflowProcessInstancePersistence.ParameterName and WorkflowProcessTimer.Name have been changed from NVARCHAR(max) to NVARCHAR(900). The migration script will automatically check if these fields contain data longer than 900 characters. If such data is found, the script will terminate with an error. In this case, you will need to manually shorten the data in these fields and rerun the migration. If you encounter difficulties during the upgrade process, please contact our support team.

Bug Fixes

• Fixed an issue where calling GetInstancedStatus on MongoDB would result in an exception.

Designer

• Fixed a bug that caused the import of the @optimajet/workflow-designer-react package as an ESM module to not work.

Core

• Introduced centralized management for packages and their dependencies using Directory.Build.props and Directory.Packages.props.
• Added a new ProcessDefinitionBuilder. For more details, refer to the documentation.
• Upgraded Newtonsoft.Json package from version 13.0.1 to 13.0.3.
• Added the capability to extend the Designer API.

Designer

• Corrected a typo in the Transition Edit Form.

Plugins

• Resolved an exception issue occurring in the RealTimeTrackingPlugin.
• Fixed an issue with an incorrect type in HttpRequestActivity within the BasicPlugin.

Bug Fixes

• Fixed an issue where adding a BuildStep with a specific ordinal number would cause an exception during the creation of the Workflow Runtime.
• Fixed an issue where invoking Shutdown multiple times in the Real-Time Tracking Plugin caused errors.

Designer

• Fixed several issues with the behavior of the CreateProcess activity.
• Fixed a bug with SignalR connection.
• Fixed a bug with plugin list.
• The braces dependency has been updated from version 3.0.2 to 3.0.3.
• Updated engine.io from version 6.5.4 to 6.5.5 in Workflow-designer-angular.
• Updated socket.io-adapter from version 2.5.4 to 2.5.5 in Workflow-designer-angular.
• Updated ws from version 8.16.0 to 8.17.1 in Workflow-designer-angular.

Core

• Fixed a bug in subprocesses execution.
• Updated Npgsql package in OptimaJet.Workflow.PostgreSQL to version 8.0.2.

Providers

• Corrected the GetProcessHistoryCount method in the MongoDB provider.

Samples

• Updated Microsoft.Identity.Client from version 4.60.3 to 4.61.3 in Microsoft SQL WebForm sample.
• Updated Azure.Identity from version 1.11.3 to 1.11.4 in Microsoft SQL Sample.

Designer

• Fixed an issue with saving custom activity.
• Added the ability to set the schema name in the designer.

Core

• Added functionality to retrieve a list of all migrations and a list of unapplied migrations.

Documentation

• Updated the "Testing workflow schemes" article with corrections related to migrations.

Samples

• Removed all .NET Framework 4.8 Samples except for the Microsoft SQL Server Sample.
• Updated .NET Framework 4.8 Samples to WorkflowEngine 13.0.0.
• Added Blazor integration Sample.

Providers

• Updated Npgsql driver from version 8.0.2 to 8.0.3.

Real-Time Tracking Plugin

• Implemented a Real-Time Tracking plugin that extends the Workflow Designer with real-time functionality, allowing live updates of process states via SignalR. For more details, refer to the documentation.

Core

• Introduced the optional capability for automatic migration, allowing the creation and updating of the database schema without manually running scripts. This feature ensures that the Workflow Engine maintains a list of executed scripts accessible within the database.

Designer

• The Workflow Designer can now be initiated directly from the command line using the npx @optimajet/workflow-designer $BackendUrl $SchemeCode command, which automates the fetching and execution of packages from the npm repository. For more details, refer to the documentation.
• Added an 'About' button to the designer’s menu, displaying both the backend and designer version information to users.

Bug Fixes

• Corrected an error related to clipboard access in the 'Instance Info' section.
• The backend now filters events to ensure that Workflow Designer receive only pertinent data. Unknown events are currently ignored.

Designer

• Added the ability to drag and resize windows on touch screens.

ApprovalPlugin

• Added a new setting InboxCheckConditions, which allows filling the inbox only with commands that satisfy all Conditions.

Core

• Resolved a bug preventing the timer from logging certain exceptions.

Providers

• Providers now utilize PackageReference instead of ProjectReference.
• Updated Npgsql package in OptimaJet.Workflow.PostgreSQL to version 8.0.2.

Samples

• Updated NetCore Samples to .NET 8.

Designer

• The designer now supports React 18.
• Updated the designer React sample to React 18.
• Added functionality to clear the PreExecution Result field in the Decision Table.
• Fixed a bug in the behavior of the Decision Table regarding transitions.
• Corrected an issue where Name and State fields were not filled in custom activities.
• Added the ability to insert a logo into the designer. For more details, refer to the documentation.

Documentation

• Included information regarding Supported .NET versions on this page.
• Updated the description of timers on this page.

Features

• Introducing a new provider for SQLite database integration.
• Added a new edition for non-commercial use: Workflow Engine Community.

Bug Fixes

• Corrected timer value validation within the designer.
• Rectified improper window positioning and movement within the designer.
• Calibrated z-index values for designer's windows.
• Resolved compilation errors in the Angular designer package.
• Fixed SQL Deadlock occurring during ExecuteCommand.
• Color palette button no longer appears in readonly mode.

Feature

• Introducing the new Bulk API for WorkflowRuntime, enabling parallel execution of large arrays of tasks. Access to this API is facilitated through the WorkflowRuntime.Bulk property.

Core

• Added input validation to the HelperDateTime.GetInterval method. When incorrect values are passed, it now returns a TimeSpan with a zero value.

Designer

• Resolved an issue where default annotation values for custom activities were not persisting in the schema without manual activity data saving.

Designer

• Fixed a bug when switching to expert mode for Decision and Decision table.
• Fixed the error of executing OnSuccessCallback in the designer.create method.
• Outdated libraries have been replaced.
• Fixed the Instance info function.
• Fixed the display after fit to screen for an empty scheme.
• The follow-redirects dependency has been updated to version 1.15.4.

Providers

• Microsoft.Data.SqlClient has been updated to version 2.1.7 in MSSQL Provider.

Features

• Added a new plugin for working with Active Directory services. For more information, refer to ActiveDirectoryPlugin.

Designer

• Displaying error from custom activities.

Providers

• Fixed a bug with query parameters in MSSQL Provider.

Plugins

• Added a base class Deactivated for disabling plugins.
• The OnPluginRemoveAsync method has been removed from the IWorkflowPlugin interface.

Breaking changes

Breaking changes only for MongoDB and Angular packages.

• MongoDB driver has been updated from 2.10.4 to 2.19.0. If you are using a multi-server mode, you need a MongoDB cluster.
• Angular designer package has been updated to Angular 17. This requires the Node 18.13.

Core

• Fixed the operation of parameters with names containing a space.
• Improved performance of subprocesses execution.

Designer

• Fixed an error displaying parameter types in the Parameters windows.
• Fixed an error displaying process parameters in the ProcessInfo window.
• Fixed an error displaying exceptions handling in the Activity window.
• Improved zoom operation.

Samples

• Angular sample updated to Angular 17.
• React package is now compatible with React 18.

Designer

• Now in the JSON editor and also in other places, JSON.stringify() is always used for formatting instead of JSON5.stringify(), so that the formatted code is always valid JSON.

This release brings a new enhanced feature as well as smoother and richer user experience.

Core

Users can now establish their Work Calendars in accordance with specific workdays, thereby preventing any unnecessary Timer activation during non-operational periods. Once you set up your calendar and append the letter <w> to your Interval Timer Value, the system will translate this interval to your established working time, adeptly bypassing non-working hours and holidays. For more information, refer to the Work Calendar documentation.

Timer

A bug associated with timer.Value mutation in TimerManagerBase has been fixed. This resolves any issues and exceptions interconnected with the GetCustomTimerValueAsync event and the CreateInstanceAsync method.

Update instruction

The following additional actions must be taken to upgrade to Workflow Engine 11.0.0 from Workflow Engine 10.0.1:

• Run the SQL script update_11_0_0.sql for all relative databases:
  • MSSQL
  • Oracle
  • MySQL
  • PostgreSQL

Designer

• @optimajet/workflow-designer-angular Fixed version release error, please use version 10.0.1 instead of version 10.0.0.