Wexflow 9.5.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Framework 4.8 This package targets .NET Framework 4.8. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Wexflow --version 9.5.2
                    


                    

                
NuGet\Install-Package Wexflow -Version 9.5.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Wexflow" Version="9.5.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Wexflow" Version="9.5.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Wexflow" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Wexflow --version 9.5.2
                    


                    

                
#r "nuget: Wexflow, 9.5.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Wexflow@9.5.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Wexflow&version=9.5.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Wexflow&version=9.5.2
                    


                            Install as a Cake Tool

Wexflow

Core assembly of the Wexflow workflow engine

This NuGet package provides the core components needed to build and extend workflows in Wexflow, a powerful and extensible open-source workflow automation engine.

Use this package to create custom tasks that can be integrated into your workflows. It includes the base Task class, logging, execution helpers, and utility functions.

Full documentation for creating custom tasks is available here.

Features

  • Base class for custom task development
  • Integrated logging and utility helpers
  • Compatible with all Wexflow editions .NET 4.8 (Legacy) and .NET 8.0+ (Stable)
  • Cross-platform support

Installation

To install via .NET CLI:

dotnet add package Wexflow

Or via NuGet Package Manager:

Install-Package Wexflow

Example: Creating a Custom Task

To define your own task, inherit from the Task class and override the Run method:

using System.Xml.Linq;
using Wexflow.Core;
using Task = Wexflow.Core.Task;
using TaskStatus = Wexflow.Core.TaskStatus;

namespace Wexflow.Tasks.MyTask
{
    public class MyTask : Task
    {
        public MyTask(XElement xe, Workflow wf) : base(xe, wf)
        {
            // Initialize task settings from the XML element if needed
            // Example: string settingValue = GetSetting("mySetting");
        }

        public override TaskStatus Run()
        {
            try
            {
                // Task logic goes here
                Info("Running my custom task...");

                // WaitOne() enables suspend/resume support in .NET 8.0+.
                // Call this to pause the task when the workflow is suspended.
                WaitOne();

                // Return success when the task completes successfully
                return new TaskStatus(Status.Success);
            }
            catch (ThreadInterruptedException)
            {
                // Required for proper stop handling (do not swallow this exception)
                throw;
            }
            catch (Exception ex)
            {
                // Log unexpected errors and return error status
                ErrorFormat("An error occurred while executing the task.", ex);
                return new TaskStatus(Status.Error);
            }
        }
    }
}

Need a starting point?

Installing Your Custom Task in Wexflow

.NET Framework 4.8 (Legacy)

Once you've finished coding your custom task, compile the class library project and copy the Wexflow.Tasks.MyTask.dll assembly into one of the following folders:

  • C:\Program Files\Wexflow\
  • C:\Wexflow\Tasks\ (default for Wexflow .NET 4.8 version)

The Tasks folder path can be configured via the tasksFolder setting in the configuration file: C:\Wexflow\Wexflow.xml

Important: The namespace and DLL filename of your task must start with Wexflow.Tasks.

.NET 8.0+ (Stable)

If you're using the .NET 8.0+ version of Wexflow, copy Wexflow.Tasks.MyTask.dll to the appropriate platform-specific folder:

  • Windows:
    • C:\Wexflow-netcore\Tasks or .\Wexflow.Server
  • Linux:
    • /opt/wexflow/Wexflow/Tasks or /opt/wexflow/Wexflow.Server
  • macOS:
    • /Applications/wexflow/Wexflow/Tasks or /Applications/wexflow/Wexflow.Server

Referenced Assemblies

If your custom task depends on additional assemblies (DLLs), copy them as follows:

  • .NET 4.8: C:\Program Files\Wexflow\
  • .NET 8.0+:
    • Windows: C:\Wexflow-netcore\Tasks or .\Wexflow.Server
    • Linux: /opt/wexflow/Wexflow/Tasks or /opt/wexflow/Wexflow.Server
    • macOS: /Applications/wexflow/Wexflow/Tasks or /Applications/wexflow/Wexflow.Server

Updating a Custom Task

To update an existing custom task:

  1. Replace the old DLL and its referenced assemblies with the new versions in the correct folder.
  2. Restart the Wexflow server:
  • .NET 4.8: Restart the Wexflow Windows Service
  • .NET 8.0+:
    • Windows: Run .\run.bat or restart Wexflow Service if you installed it as a Windows Service
    • Linux: Run sudo systemctl restart wexflow
    • macOS: Run dotnet /Applications/wexflow/Wexflow.Server/Wexflow.Server.dll

Using Your Custom Task

Once installed, your task can be used in workflows like this:

<Task id="$int" name="MyTask" description="My task description" enabled="true">
    <Setting name="settingName" value="settingValue" />
</Task>

You can then test your custom task by creating a new workflow using either the Designer or the XML editor.

Example using the XML editor:

<Workflow xmlns="urn:wexflow-schema" id="99" name="Workflow_MyWorkflow" description="Workflow_MyWorkflow">
    <Settings>
        <Setting name="launchType" value="trigger" />
        <Setting name="enabled" value="true" />
    </Settings>
    <Tasks>
        <Task id="1" name="MyTask" description="My task description" enabled="true">
            <Setting name="settingName" value="settingValue" />
        </Task>
    </Tasks>
</Workflow>

This workflow will appear in the Wexflow Manager. You can launch and monitor it from there.

That's it! You're now ready to create, install, and run your own custom tasks in Wexflow.

For issues, contributions, or updates, visit the Wexflow GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Framework net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Wexflow:

Package Downloads
OO.Workflow.Wexflow

Wexflow types and implementations for EasyDataCore infrastructure

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
10.0.0 827 11/13/2025
9.9.0 360 9/11/2025
9.8.0 491 7/25/2025
9.7.0 547 7/23/2025
9.6.0 593 7/22/2025
9.5.2 505 7/21/2025
9.4.0 185 7/18/2025
9.3.0 204 7/16/2025
9.2.0 228 7/14/2025
9.1.0 169 7/11/2025
9.0.0 214 7/10/2025
8.9.0 294 6/19/2025
8.8.0 546 5/15/2025
8.7.0 220 5/3/2025
8.6.0 349 4/16/2025
8.5.0 482 2/19/2025
8.4.0 798 11/26/2024
8.3.0 521 9/19/2024
Loading failed

Bug fixes, performance enhancements, and internal improvements.