Release Notes

6.1.0

November 15, 2024

Features

• BPMN Plugin: added WorkflowEngine.NETCore-BpmnPlugin. This plugin enables the import of bpmn schemes.
• Fixed an issue where the install and uninstall service scripts fail.
• Fixed an issue causing an unnecessary page reload when opening schemes in Workflow/Manage Schemes page.

6.0.0

November 08, 2024

Features

• Workflow Engine has been upgraded to version 16.1.0, refer to the release notes for more information.

Dependencies

• http-proxy-middleware has been updated from version 2.0.6 to 2.0.7.
• cookie has been updated from version 0.6.0 to 0.7.1.
• express has been updated from version 4.21.0 to 4.21.1.

5.3.0

September 24, 2024

Features

• Workflow Engine has been upgraded to version 14.1.0, refer to the release notes for more information.
• Node has been updated to version 20.17.0.

Dependencies

• serve-static has been updated from version 1.15.0 to 1.16.2.
• micromatch has been updated from version 4.0.5 to 4.0.8.
• webpack has been updated from version 5.76.0 to 5.94.0.

5.2.3

August 21, 2024

Bug Fixes

• Fixed a visual glitch in plugin settings behavior after a page refresh.
• Fixed an issue where the uploadScheme method in DesignerApi could throw an exception.
• Fixed an issue causing WorkflowServer to have prolonged startup times in developer mode.
• Fixed an issue where CodeAction might not save correctly in developer mode.
• Fixed an issue where RealTimeTrackingPlugin failed to initialize in developer mode.

5.2.2

August 09, 2024

Features

• Workflow Engine has been upgraded to version 13.3.0, refer to the release notes for more information.

Bug Fixes

• Fixed an issue occurring during the creation of CodeAction in Developer Mode.

5.2.1

July 30, 2024

Features

• Workflow Engine has been upgraded to version 13.2.2, refer to the release notes for more information.

Bug Fixes

• Fixed errors occurring during report generation on PostgreSQL, MySQL, and MongoDB.
• Fixed an issue caused by attempting to delete all processes on an incomplete page.
• Added the Real Time Tracking Plugin name to the localization.
• Fixed an issue where the Real Time Tracking Plugin was not initializing.
• Fixed an issue with prolonged loading of the "Manage instances" page.

5.2.0

June 27, 2024

Dependencies

• The braces dependency has been updated from version 3.0.2 to 3.0.3.
• Updated ws from version 7.5.9 to 7.6.10.

Features

• Workflow Engine has been upgraded to version 13.2.1, refer to the release notes for more information.
• New Migrator tool: introduced WorkflowEngine.NETCore-Migrator. The database update method has been changed to use the mechanism from WorkflowEngine.
• Real-Time Tracking Plugin: added WorkflowEngine.NETCore-RealTimeTrackingPlugin. This plugin enables real-time tracking of process states.

5.1.0

February 23, 2024

Features

• Workflow Engine has been upgraded to version 12.2.0, refer to the release notes for more information.

Bugfixes

• Callback API now correctly displays enabled or disabled status.

5.0.0

January 31, 2024

Breaking changes

• WorkflowEngine has been updated to version 12.1.1, refer to the release notes for more information.
• WorkflowServer has been updated to .NET 8.

Features

• Added documentation for the Workflow API response.
• Added the ability to add custom HTTP headers for admin and frontend servers.
• Added the ability to register your own services in a DI container.
• Added a Create an instance icon in the designer.

Dependencies

• The Microsoft.AspNetCore.Authentication.JwtBearer library has been updated to 3.1.32.
• The microsoft/signalR library has been updated from 3.1.9 to 8.0.0.
• The IdentityServer4 library has been updated from 4.1.1 to 4.1.2.
• The react-virtualized library has been updated from 9.22.3 to 9.22.5.

Bugfixes

• Fixed a typo Exeptions in the JSON error message.

4.0.0

October 20, 2023

Features

• Workflow Engine has been upgraded to version 11.0.1, refer to the release notes for more information.
• Added SchemeCode, ActivityName, and StateName filter parameters to the WorkflowAPI getinstances method.

Breaking changes

• The resume WorkflowAPI method no longer returns the processDefinition domain object.
• Added a new CalendarName column to the WorkflowProcessInstance table. Use the following SQL script to update the database:
  • MSSQL
  • MySQL
  • Oracle
  • PostgreSQL

Bug fixes

• Updated NPM packages @babel/travers and postcss due to discovered vulnerabilities in these packages.

3.5.0

September 18, 2023

Features

• Workflow Engine has been upgraded to version 10.0.1, refer to the release notes for more information.
• A couple of packages have been updated to prevent package-related vulnerabilities.

3.4.2

June 8, 2023

Bug fixes

• The critical error has been fixed where the WorkflowServer didn't start in the release build configuration.

3.4.1

June 6, 2023

Bug fixes

• The bug causing the custom plugin settings to not update has been fixed.

3.4.0

June 2, 2023

Features

• Workflow Engine has been upgraded to version 9.1.1, refer to the release notes for more information.
• In the Workflow API, the ability to specify tenantId has been added to all methods for working with users. When a non-null tenantId is provided, the operation will only be performed on users with the same tenantId. If you attempt to modify or delete a user with a different tenantId, you will receive a failed response. If a null tenantId is passed, no verification will be performed.

Bug fixes

• The Workflow API now generates clear errors instead of returning internal exceptions.
• A bug has been fixed where the extensions field was not being updated in the workflowapi/updateuser method.
• In the MongoDB provider, pagination has been fixed in the workflowapi/getinstances method. The total count is now returned when skip parameter is greater than the total count. Additionally, if you request 0 records in the take parameter, all existing records will be returned.

3.3.2

April 27, 2023

Bug fixes

• The "Open instance" button has been restored in the createinstance WorkflowAPI method.

3.3.1

April 25, 2023

Bug fixes

• Fixed a bug where it was possible to edit and delete schemes when the "BlockMetadataChanges" setting was enabled.

3.3.0

April 21, 2023

Features

• Workflow Engine has been upgraded to version 9.0.0, refer to the release notes for more information.
• The updateinstances WorkflowAPI method now includes an async parameter that enables you to specify whether to use the asynchronous or synchronous overload.
• The getuser WorkflowAPI method now returns user with included credentials without secrets.

Bug fixes

• All WorkflowAPI methods now consistently return null on failure instead of an empty string.
• Fixed a bug that caused the tenantId assert to result in a 500 status code when the process was not found.
• Fixed an issue where the WorkflowAPI getuser method returned incorrect error messages.

3.2.0

March 24, 2023

Features

• Workflow Engine has been upgraded to version 8.1.0, refer to the release notes for more information.
• The "Manage schemes" page in the admin panel has been revamped with a new list view, pagination, and advanced filtering options.
• The "Workflow API" page has been updated with processId lookup and extended descriptions.

Bug fixes

• Fixed a bug with the "WorkflowReportBySchemes" stored procedure in MySQL.
• Resolved issues with the user interface on the "Callback API" page.
• Fixed a bug with pagination on the "Manage instances" page when filtering.
• Resolved an issue with workflow scheme updates not being applied after import.
• Fixed a bug with localization not updating in the designer when changed in the Workflow Server.
• Resolved an issue where the Docker container was not starting on Ubuntu systems.

Update instructions

• Run the update_wfs_3_2.sql script if you are using a MySQL database.

3.1.1

February 6, 2023

• Fixed missing OptimaJet.WorkflowServer.Plugins namespace bug.
• Fixed ConfigApi hidden response status bug.

3.1.0

December 27, 2022

• Updated to Workflow Engine .NET 7.2.3.
• Several improvements and bug fixes in the admin panel.
• The getuser method has been added to the Workflow API.
• The getschememodel method has been added to the Workflow API.
• AssertNullOrWhitespaceTenantId parameter has been added to the config.json.
• GlobalCommandTimeout parameter has been added to the config.json.
• Added the ability to automatically redirect to the provider's OpenID on the login page.
• Fixed several bugs in the embedded forms and the embedded designer.

3.0.2

September 9, 2022

• Removed unused code

3.0.1

August 22, 2022

Workflow API

• Bug fixes in the "Inbox folder" and "Outbox folder" methods

3.0

April 15, 2022

• Workflow server running under .NET 6.

• Added process log stored in the database. It is accessed through the process scheme.

• Added setting SettingsCache - caching settings in the server instance. It only applies to Callback server settings at the moment.

  {
  	"SettingsCache": {
  		"Lifetime" : 60000,
  		"Retries" : 5,
  		"RetryDelay" : 100
  	}
  }

Admin panel

• Redesigned and improved the admin panel interface.
• Added a dark theme.
• Added the ability to partially import or export a configuration.

Users and Security

• It is possible to give the user the admin role, so they can access the administration panel.

• Using the setting in config.json, you can disable the API for changing users.

  {
  	"WorkflowApi": { "BlockUserApi": true }
  }

• LDAP passwords are always encrypted.

Callback API

• Added the possibility to enter test values in the Callback API interface.

• Added the ProcessLog method that sends a process log to the Callback server.

• Added possibility to use external parameters.

• Added the possibility to disable the Callback API.

• Added culture to the Get Available Commands method.

• It is possible to deploy multiple WFS instances at the same address. For example: http://localhost:8077/admin, http://localhost:8077/forms etc. Use PathBase setting to do that.

  {
  	"PathBase": "/admin/"
  }

Workflow API

• Added Get instances method to find processes.

Forms

• Added the ability to quickly customize the form interface.

Breaking changes

• Removed the CallbackServerRequestType setting - which was needed for compatibility with WFS versions prior to 2.0

Update instructions

The following additional actions must be taken to upgrade to Workflow Server 3.0:

• Run the SQL script update_wfs_3_0 for all relative databases.
  • MSSQL
  • PostgreSQL
  • Oracle
  • MySQL

2.11.0

March 3, 2022

Changes

• Updated to Workflow Engine .NET 5.2.3.

2.10.0

December 9, 2021

Changes

• Updated to Workflow Engine .NET 5.2.1.
• Added LDAP password encryption (Working with Users).

2.9.2

December 3, 2021

Changes

• Fixed launching docker container on CentOS.
• Fixed sample on the site.

2.9.1

November 18, 2021

Changes

• Added mapping of LDAP attributes in LDAP settings.

2.9

November 10, 2021

Changes

• Updated to Workflow Engine .NET 5.2. Please review the Workflow Engine Release notes to find out what functionality of Workflow appeared in Workflow Server.
• Added a Filter and Connection Test features into LDAP Setting.

Breaking changes

• If you are using SetParameter action/activity from the Basic Plugin pay attention that:

  • Before the parameter value was always interpreted as a string
  • Now the parameter value is the compilable expression

  If you need to preserve old behavior please switch on the "Don't compile expressions" setting of the Basic Plugin.

Update instructions

The following additional actions must be taken to upgrade to Workflow Server 2.9:

• Run the SQL script update_wfs_2_9 for all relative databases.
  • MSSQL
  • PostgreSQL
  • Oracle
  • MySQL

2.8

April 6, 2021

• Updated to Workflow Engine .NET 5.1

The following additional actions must be taken to upgrade to Workflow Server 2.8:

• Run the SQL script update_wfs_2_8 for all relative databases and MongoDB.
  • MSSQL
  • PostgreSQL
  • Oracle
  • MySQL
  • MongoDB

2.7

November 9, 2020

• Updated to Workflow Engine .NET 5.0
• Workflow Server application now runs on .NET Core 3.1 platform.
• Users are added to the database and Admin panel. Users can be created and modified through the Admin panel, through the Workflow API methods and using synchronization via LDAP.
• Users can be assigned with Roles, thus the role-based authorization of full value became available in the Workflow.
• Added authorization for forms based on OpenId, added authentication option via Facebook, Google and Okta.
• CallbackApi is now able to connect multiple callback servers.
• Files Plugin and Loops Plugin from Workflow Engine .NET have been added.
• Added an option to import and export server configuration. All server settings, schemes, code actions, forms and users are exported (and imported).
• Added Developer Mode, in which the server configuration is also saved to hard drive. The directory is specified in the configuration file of a specific instance.
• Added an option to embed forms into other web-sites and applications.
• In the Workflow API has been added the Resume method which resumes the process execution.
• In the Workflow API has been added a method to update the process scheme to a new one. The same feature has been added to the Admin panel interface.

The following additional actions must be taken to upgrade to Workflow Server 2.7:

• Install .NET Core 3.1, if you don't already install it.

• Run the SQL script update_wfs_2_7 for all relative databases and MongoDB.

  • MSSQL
  • PostgreSQL
  • Oracle
  • MySQL
  • MongoDB

• Add the following settings into the configuration file.

  {
    // ...
    "DeveloperMode": false,
    "ExternalEventLoggerConfig": {
      "ConsoleTarget": [ "Error" ]
    },
    "AuthorityUrl" : "http://localhost:8077",
    "IdentityServerSettings": {
      "CertificateFile": "IdentityServer4Auth.pfx",
      "CertificatePassword": "password",
      "RedirectHosts": [ "http://localhost:8077", "http://localhost:8078" ],
      "RedirectUrls": [],
      "UseHostRedirectValidator": false
    },
    // ...
  }

2.6

June 8, 2020

• Updated to Workflow Engine .NET 4.2

• Support of the multi-server mode has been added. If you need to run the Workflow Server instance in multi-server mode, add the following setting to the config.json file.

  {
    "IsMultiServer": true
  }

• Added database logs with records search possibility.

• Added new Workflow API methods for managing a Workflow Server instance. Start, Stop and IsActive.

• Added ability to develop the end-user forms (frontend interface) based on Vue.js. It is the beta version. Access control for these forms will be added in the next version.

If you use global Code Actions and you have several servers deployed, then to apply the changes you need to restart each of them. To do this, you can use the Start method from the Workflow API.

The following additional actions must be taken to upgrade to Workflow Server 2.6:

• Run the SQL script update_wfs_2_6 for all relative databases and MongoDB.
  • MSSQL
  • PostgreSQL
  • Oracle
  • MySQL
  • MongoDB

2.5

January 10, 2020

• Updated to Workflow Engine .NET 4.0
• Support for multi-tenant applications.
  • TenantId has been added to processes. When creating a process using the createinstance WorkflowAPI method, one can specify TenantId and use its value to work with the process. Also, when manipulating a process using WorkflowAPI methods, one can optionally assign TenantId; once TenantId is specified, its compliance with the initial TenantId value set at the process creation is automatically checked.
  • For schemes one can specify tags, and then, search for schemes where these tags are indicated. Tags can be set on the Workflow/Manage Schemes admin page. In the getschemelist WorkflowAPI method, one can specify a list of tags to search for schemes. The search is performed using an OR expression.
• The possibility to set a login and a password to access the WorkflowServer admin panel has been provided. This setting is available on the Dashboard page in the Security tab.
• The possibility to set an access token to access the WorkflowAPI methods has been provided. This setting is available on the Dashboard page in the Security tab.
• The Basic Plugin has been connected to the WorkflowServer, it can be enabled on the Dashboard page in the Plugins tab. For a full list of methods, please, see here.
• Using the createinstance, executecommand and get state of WorkflowAPI methods, one can pass implicit (that is, not explicitly described in the process scheme) persistent parameters. A parameter can also be a valid JSON object of any complexity. In this case, the type DynamicParameter should be applied to control such a parameter in the code.
• The getparameter and setparameter methods to read and modify process parameters have been added to WorkflowAPI.
• Intellisense has been added to the Code Actions editor, in schemes and in the Workflow / Global Code Actions section of the admin panel.
• In the API / Workflow API section, forms to execute WorkflowAPI methods have been added; an example request is also generated there.

Update guide to WFS 2.5

The following additional actions must be taken to upgrade to Workflow Server 2.5:

• Run the following SQL script for all relative databases.

  • MSSQL
  • PostgreSQL
  • Oracle
  • MySQL

• IMPORTANT! Incorrect behavior was fixed when the subprocess was merged in the parent process via the set state of the parent process mechanism. Previously, the parent process parameters were OVERWRITTEN. Now, the parent process parameters won't be changed. Only new parameters from the subprocess will be written to the parent process automatically. The same way the merge via calculating conditions always works. If you consciously exploited this behavior, then the best way to get parameters from the subprocess is to use a property processInstance.MergedSubprocessParameters when merge occurs.

• In the previous versions, implicit parameters passed by the WorkflowAPI methods were always interpreted as strings. Starting from version 2.5, the WorkflowServer converts these parameters to types (int, bool, double, DynamicParameter etc.). If it’s important for you to keep the old behavior, add the following setting to the config.json file.

  {
    "ImplicitParametersParsingType": "Legacy"
  }

• In the previous versions, process parameters were transferred to Callback server in the camel case. That is, the first letter of the parameter name (for example, 'Parameter1') became small ('parameter1'). Now, the parameter name will not change. If it’s important for you to keep the old behavior, add the following setting to the config.json file.

  {
    "CallbackServerJsonSerialization": "CamelCase"
  }

2.4

May 6, 2019

• Updated to Workflow Engine .NET 4.0

The following additional actions must be taken to upgrade to Workflow Server 2.4:

• Run the SQL script update_WFE_4_0.sql for all relative databases.

2.3

November 6, 2018

• Added localization for German, French, Spanish, Italian, Portuguese, Turkish, and Russian languages.
• Added a setting that enables you to specify the database schema the server connects to - SchemaName.
• The GetSchemeList method which returns a list of schemas the server has was added to the server API.
• A logging system was added. Errors, debug info and info messages are logged into the console, debug output or files. Logging can also be performed to the Windows Event Log for a Windows service.
• The LogInfo, LogError, LogMessage methods were added to write to the log from outside the server.
• The WorkflowRuntime object which is always accessible in standard Workflow Engine Actions has new capabilities. runtime.Logger - object - logger to write messages to log. runtime.LogError(), runtime.LogDebug(), runtime.LogInfo() - methods to write messages to log.
• The docker container that has a server with an ability to pass all config parameters for a setup was published.

2.2

September 14, 2018

• MongoDB support has been added. This type of connection also works with Cosmos DB.

2.1

August 23, 2018

• Added Oracle and MySQL support
• The ExecuteCommand method from WorkflowAPI returns information on whether the command was executed and process state after execution (including all process parameters)
• The source code of a console application which you can connect your IWorkflowActionProvider and IWorkflowRuleProvider to and perform fine-tuning of Workflow Engine was uploaded to GitHub

2.0

March 22, 2018

• First release of Workflow Server 2.0