BPMNEngine 3.1.0

dotnet add package BPMNEngine --version 3.1.0                
NuGet\Install-Package BPMNEngine -Version 3.1.0                
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="BPMNEngine" Version="3.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BPMNEngine --version 3.1.0                
#r "nuget: BPMNEngine, 3.1.0"                
#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.
// Install BPMNEngine as a Cake Addin
#addin nuget:?package=BPMNEngine&version=3.1.0

// Install BPMNEngine as a Cake Tool
#tool nuget:?package=BPMNEngine&version=3.1.0                

BPMEngine

A BPMN Engine written in .net. The engine attempts to read in a bpmn notation xml document defining both the process(s) as well as the diagrams. From here you can then load/unload the state, render the diagram in its current state or animated into a gif. Using the delegates for a process, you intercept and handle task and condition checking by reading additional xml held within flow and task objects. Thanks to our authorized private software HRForms.App for their continues support and testing.

Current Test Status:

.NET-Test-6x
.NET-Test-7x
.NET-Test-8x
Jint-3.0.0-beta-1138
CodeQL
codecov

XSD

Adding xmlns:exts="https://raw.githubusercontent.com/roger-castaldo/BPMNEngine/master/Extensions" to the bpmn:definitions will make things easier for accessing the defined xsd file for the project.
This references all the extended elements defined below.

Internal Conditions

Using bpmn:extensionElements inside a (bpmn:sequenceFlow,bpmn:process,bpmn:startEvent) you can specify conditions to be analyzed based on process variables and some basic comparisons by using a conditionSet xml tag with the following components inside.

Comparison Components

Tags: isEqualCondition, greaterThanCondition, lessThanCondition, greaterThanOrEqualCondition, lessThanOrEqualCondition Attributes:

  • leftVariable : used to indicate the name of the variable to place on the left side of the comparison
  • rightVariable : used to indicate the name of the variable to place on the right side of the comparison SubElements:
  • left : used to indicate a constant value for the left side of the comparison
  • right : used to indicate a constant value for the right side of the comparison Rules: A tag can contain either a leftVariable or left element as well as either a rightVariable or right element

Example: <isEqualCondition leftVariable="username"> <right>bob.loblaw</right> </isEqualCondition>

Negate Component

Used to negate the sub condition Tag: notCondition SubElements: andCondition, orCondition, isEqualCondition, greaterThanCondition, lessThanCondition, greaterThanOrEqualCondition, lessThanOrEqualCondition

Example: <notCondition> <isEqualCondition leftVariable="username"> <right>bob.loblaw</right> </isEqualCondition> </notCondition>

Null Check Component

Used to check if variable is null Tag: isNull Attributes: variable

Example: <isNull variable="username"/>

Comparison Collectors

Tags: andCondition, orCondition Attributes: none SubElements: andCondition, orCondition, notCondition, isEqualCondition, greaterThanCondition, lessThanCondition, greaterThanOrEqualCondition, lessThanOrEqualCondition

Example: <andCondition> <isEqualCondition leftVariable="firstName"> <right>bob</right> </isEqualCondition> <isEqualCondition leftVariable="lastName"> <right>loblaw</right> </isEqualCondition> </andCondition>

Dynamic Internal Code

Executing Script tasks internally with dynamically compiled C#/VB.Net code. Simple place an bpmn:extensionElements inside a script task and supply the following elements inside. These script tags can also be used inside condition sets to return a boolean value for more complex condition checking.

Tags: cSharpScript (for C# code), VBScript (for VB.Net code) SubElements: code, using, dll

Within the script element tag, either place the code (assuming there is no references required) or place the sub elements including 1 code element. To acess the variables for the process at that point, the variable variables is passed into the code, which is an instance of ProcessVariablesContainer. Any changes made to the variables object will be passed back into the system and the process variables updated for that step.

The using tag should contain a namespace reference as its value, the script tag will take care of the formatting in the code, for example: System.Data The dll tag should contain a dll reference in its value, for example: System.Data.dll

Example: <bpmn:scriptTask id="Task_1kqkg76" name="Close Request"> <bpmn:extensionElements id="extTask_1kqkg76"> <VBScript> variables("username") = "bob.loblaw" </VBScript> </bpmn:extensionElements> bpmn:incomingSequenceFlow_0xp0bq2</bpmn:incoming> bpmn:outgoingSequenceFlow_13xe9al</bpmn:outgoing> </bpmn:scriptTask>

The example above will set the variable "username" to "bob.loblaw" when the script task is called.

Javascript Code

Executing Javascript code internally using the variables parameter. This is done by dynamically loading JINT to process javasacript inside .Net. These can be used for both script tasks as well as condition checking.

Tag: Javascript

Within the script element tag, you must supply the javascript code to be run.

Example: <Javascript> variables["username"] = "bob.loblaw" </Javascript>

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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.1.0 116 9/5/2024
3.0.0 220 1/11/2024
3.0.0-beta1 143 6/15/2023

Major revision to a new library with breaking changes, including the concept of a process instance and creating named parameters for supplying all delegates.  Improved memory management and performance has been acheived using built in dotnet concepts that also display improved performances when running inside .net8 vs .net7 vs .net6.