Calway.Automation
0.9.10
Prefix Reserved
See the version list below for details.
dotnet add package Calway.Automation --version 0.9.10
NuGet\Install-Package Calway.Automation -Version 0.9.10
<PackageReference Include="Calway.Automation" Version="0.9.10" />
paket add Calway.Automation --version 0.9.10
#r "nuget: Calway.Automation, 0.9.10"
// Install Calway.Automation as a Cake Addin #addin nuget:?package=Calway.Automation&version=0.9.10 // Install Calway.Automation as a Cake Tool #tool nuget:?package=Calway.Automation&version=0.9.10
Calway.Automation
This library implements an Automation Workflow/Statemachine with strongly typed State
Usage
The main goal was to have a workflow in code where the state could be persisted (as json) in a database and based on the database record we could recreate the Automation and the State.
Create it in code
using Calway.Automation;
var automation = new EmailWorkflow();
automation.SetState(state => {
state.Email = "email@domain.com";
});
automation.NextStep();
Console.WriteLine(automation.LastStepResult.ToString());
public class EmailWorkflowState
{
public string Email { get; set; }
public DateTime FirstEmailSent { get; set; }
public DateTime ReminderEmailSent { get; set; }
}
public class EmailWorkflow : AutomationEngine<EmailWorkflowState>
{
class FirstEmailStep: AutomationStep<EmailWorkflowState>
{
public FirstEmailStep(string id, string name) : base(id, name)
{
}
public override bool Action(EmailForkflowState state)
{
// Add code to send the First Email
state.FirstEmailSent = DateTime.UtcNow;
}
/// <summary>
/// After sending the email we can wait for 14 days before we need to take action again. We could just check every day
/// but when we already now that any Transition after this Step will be 14 days we can use that to optimize. Since not all
/// transitions are based on time we need to choose a delay ourselves.
/// </summary>
public override DateTime? NextStepTriggerDate(EmailWorkflowState state) => DateTime.UtcNow.AddDays(14);
}
class ReminderEmailStep: AutomationStep<EmailWorkflowState>
{
public ReminderEmailStep(string id, string name) : base(id, name)
{
}
public override bool Action(EmailForkflowState state)
{
// Add code to send the Reminder Email
state.ReminderEmailSent = DateTime.UtcNow;
}
/// <summary>
/// After sending the reminder we will wait another 7 days
/// </summary>
public override DateTime? NextStepTriggerDate(EmailWorkflowState state) => DateTime.UtcNow.AddDays(7);
}
/// <summary>
/// After sending the First email we wait for 14 days before continuing.
/// </summary>
private bool ReminderEmailCondition(EmailWorkflowWState state) => state.FirstEmailSent < DateTime.UtcNow.AddDays(-14);
public EmailWorkflow() : base()
{
AddStep(new FirstEmailStep("first-email", "Send the first Email")
AddConditionalTransition("reminder-email", ReminderEmailCondition);
AddStep(new ReminderEmailStep("reminder-email", "Send a reminder Email");
}
}
This automation start by sending an initial email, and then waits for 14 days before sending a reminder email and waiting 7 days before closing/ending this automation.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.CSharp (>= 4.7.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 6.0.0)
- System.Text.Json (>= 6.0.5)
-
.NETStandard 2.1
- Microsoft.CSharp (>= 4.7.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 6.0.0)
- System.Text.Json (>= 6.0.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
* Fixed Mermaid issue when Transition Name was empty