Workflow Engine 14.0.0

August 29, 2024

Overview

Workflow Engine 14.0.0 introduces a new product, Workflow Engine Web API, and adds unique indexes across all database providers to improve data consistency and integrity.

Why update

• Integrate a ready-to-use ASP.NET Web API layer for managing Workflow Engine data and processes.
• Reduce duplicate records and improve data integrity with new unique indexes across providers.
• If you encountered GetInstancedStatus exceptions on MongoDB, this release fixes that issue.

Key features

• Introduced Workflow Engine Web API for ASP.NET integration.
• Added a RESTful Data API for safe interaction with Workflow Engine data.
• Added permission-based security so you can expose Web API endpoints by role, control access per endpoint, and issue user claims.
• Prepared RPC API support (coming in future releases).
• Added unique indexes for: WorkflowGlobalParameter (Type, Name), WorkflowInbox (ProcessId, IdentityId), WorkflowProcessInstancePersistence (ProcessId, ParameterName), WorkflowProcessTimer (ProcessId, Name).
• Added a unique index for WorkflowScheme.Code in MongoDB.

Changelog

Update instructions

• Update all packages to 14.0.0.
• For SQL providers, apply migrations using the built-in migration mechanism.
• For MongoDB, run update_14.0.0.js manually.
• You can apply these indexes selectively if your deployment requires partial adoption.
• For MS SQL Server only: WorkflowProcessInstancePersistence.ParameterName and WorkflowProcessTimer.Name are changed from NVARCHAR(max) to NVARCHAR(900) for index creation.
• For MS SQL Server only: the migration script validates values longer than 900 characters and stops with an error if found; shorten those values and rerun migration.

Features

• Added Workflow Engine Web API as a new product in the Workflow Engine ecosystem.
• Added RESTful Data API and permission-based access model for secure multi-role Web API integrations.
• Added unique indexes across SQL providers and MongoDB.

Enhancements

• Added optional/partial adoption path for new indexes depending on deployment needs.

Bug fixes

• Fixed issue where calling GetInstancedStatus on MongoDB caused an exception.

Resources

• Web API documentation: Workflow Engine Web API.
• Migration approach reference: Database migrations (versioning).
• Upgrade support: support@optimajet.com.