Scheduled Background Tasks made easy with Elsa Workflows

Sipke Schoorstra — Sun, 06 Dec 2020 20:21:45 +0000

Implementing background tasks could hardly be any simpler with ASP.NET Core today. But when it comes to scheduling background tasks, what do you do?

As it turns out, you have a number of very attractive options available to you. Specifically, I’m thinking:

ASP.NET Core Hosted Service
Quartz.NET
Elsa Workflows (the reason you are reading this post)

We’ll take a brief look at each of these options and see how they compare.

Hosted Service

If all you need is a recurring task that executes at a set interval, the simplest option (without taking on any external package dependencies) might be to implement a Hosted Service and perform work in an infinite loop until the cancellation token is triggered.

For example:

This is perfectly fine for performing work in the background at a specific interval. But what if you want to schedule work using more advanced schedules, like using a cron schedule?

As demonstrated in this article, you might implement that as a hosted service yourself. But it does require quite a bit of code.

So what about Quartz.NET?

Quartz.NET

Quartz.NET is an open source scheduling system for .NET that is flexible and easy to use. It offers many features that makes scheduling jobs super-easy.

With Quartz.NET, you get all sorts of scheduling options in the form of triggers, which include simple triggers and cron triggers.

To implement a job that executes on a given schedule, all you need to do is implement a Job class that performs the work, register it with Quartz, and then schedule it using one or more triggers.

For example:

This might be all you need to implement scheduled jobs.

But there’s a third option that makes this easier, more flexible and even more powerful.

Elsa Workflows

Elsa Workflows is an open source library for .NET that enables applications to implement both short-running and long-running workflows, either in code, using a designer, or both.

Even if you have zero interest in working with workflow systems and designers, Elsa comes with an easy to use API to implement background tasks.

The Elsa equivalent of a Hosted Service in .NET Core and a Job in Quartz.NET is the Workflow.

As a matter of fact, Elsa Workflows’ scheduling mechanism directly uses Quartz.NET to schedule work at a given time.

To implement a workflow, all you have to do is implement IWorkflow and register it with DI. That’s it.

For example, to implement a scheduled job, you could create the following workflow:

And then register it with DI like this:

services
   .AddElsa()
   .UseConsoleActivities()
   .UseTimerActivities()
   .AddWorkflow<MyJob>();

Yep, that’s pretty easy.

Of course, most background jobs will do a little bit more than just printing the current date and time to the console. For example, you may want to clean out the trash every Monday morning at 08:00:

Looks pretty neat!

Not only does Elsa simplify declaring scheduled tasks with this simple API, it automatically opens the door for you to implement actual workflow stuff (since after all, this is a real workflow!).

For instance, after cleaning out the trash, you may want to sleep for a while, walk the dog and do some dishes, perhaps something like this:

Notice that in this version of the workflow, there are two time-based triggers:

Cron (which starts the workflow ever Monday morning at 08:00)
Timer (which starts ticking after the trash has been cleaned).

Implementing this with Quartz.NET would require you to manually schedule a new job, possibly from some event handler raised by the clean up service. Doable, but increasingly harder to follow as complexity increases.

And of course it would be quite sad for the dog to be walked on Monday mornings only. Fortunately Elsa makes it easy to fix that by just declaring another workflow class that takes good care of the dog.

To learn more about Elsa, checkout the project on GitHub.

Note: the Elsa-related code described in this article targets Elsa 2.0-preview.

Summary

So there you have it! We looked at 3 viable options of implementing scheduled tasks in .NET Core / .NET 5.

The Hosted Service option is great for simple, recurring schedules and requires no external packages. But if you want cron schedules, you better pull up your sleeves and start writing some code.

Next, we looked at Quartz.NET, which I think is pretty awesome for implementing background tasks.

Finally, we looked at Elsa Workflows, which I think is another great choice to make implementing background tasks a real breeze. And being a workflow, it automatically enables you to implement more complex, long-running process flows, where you can mix & match any kind of trigger beyond time-based events. Examples include service bus messages, HTTP requests, application-specific events, and virtually anything you can dream up.

DEV Community: Sipke Schoorstra

Scheduled Background Tasks made easy with Elsa Workflows

Hosted Service

Quartz.NET

Elsa Workflows

Summary