OptimaJet.Workflow.Api.Forms 23.0.0

OptimaJet.Workflow.Api.Forms

OptimaJet.Workflow.Api.Forms adds Workflow Forms operations to the ASP.NET Core HTTP API for Workflow Engine by Optimajet. It registers the Forms Plugin in API-created Workflow Runtime instances and exposes operations to retrieve, save, and execute forms.

Workflow Forms · Documentation · Release notes

Install

Install this package together with the core API and one database integration. SQLite keeps an evaluation setup self-contained:

dotnet add package OptimaJet.Workflow.Api
dotnet add package OptimaJet.Workflow.Api.Forms
dotnet add package OptimaJet.Workflow.Api.Sqlite

OptimaJet.Workflow.Api.Forms depends on OptimaJet.Workflow.Api and WorkflowEngine.NETCore-FormsPlugin. The API extension targets .NET 8 and .NET 10; the runtime Forms Plugin targets .NET Standard 2.0.

Register Workflow Forms

Set WorkflowApi:LicenseKey to a Workflow Engine key that includes Forms, then register the services:

using OptimaJet.Workflow.Api;
using OptimaJet.Workflow.Api.Forms;
using OptimaJet.Workflow.Api.Sqlite;
using OptimaJet.Workflow.Core.Runtime;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddWorkflowApiCore(options =>
{
    options.LicenseKey = builder.Configuration["WorkflowApi:LicenseKey"]!;
});
builder.Services.AddWorkflowApiSqlite();
builder.Services.AddWorkflowRuntime(options =>
{
    options.ConnectionString = "Data Source=workflow.db";
    options.WorkflowRuntimeCreationOptions.ConfigureWorkflowRuntime = runtime => runtime.AsSingleServer();
});
builder.Services.AddFormsPlugin(options =>
{
    options.FormsManagerUrl = "https://your-app.example/forms-manager";
});

var app = builder.Build();
app.MapWorkflowApi();
app.Run();

FormsManagerUrl is the browser URL opened from Workflow Designer. The existing MapWorkflowApi() call publishes four Forms operations under the configured HTTP API base path:

• retrieve a standalone form;
• retrieve executable forms for a process;
• save form data or a draft;
• execute a form command.

The package also supports ordered IFormsApiFormDataPipelineStep implementations for converting data between an HTTP client and the runtime. Authentication, authorization, and CORS remain the responsibility of the host application.

Licensing and support

The Forms Plugin is a license-gated Workflow Engine feature. The application license must include Forms. This package is governed by the Workflow Engine EULA.

• Technical questions: support@optimajet.com
• Editions and evaluation: hello@optimajet.com

Source repository and issues