SilkierQuartz

License: MIT GitHub Actions Workflow Status NuGet version

SilkierQuartz is a new after merging Quartzmin and QuartzHostedService!

Quartz.NET is a full-featured, open source job scheduling system that can be used from smallest apps to large scale enterprise systems.

Quartzmin Quartzmin is powerful, easy to use web management tool for Quartz.NET

QuartzHostedService QuartzHostedService is easy to host Quartz as service in .Net Core !

So

SilkierQuartz can be used within your existing application with minimum effort as a Quartz.NET plugin when it automatically creates embedded web server.

Demo

The goal of this project is to provide convenient tool to utilize most of the functionality that Quartz.NET enables. The biggest challenge was to create a simple yet effective editor of job data map which is heart of Quartz.NET. Every job data map item is strongly typed and SilkierQuartz can be easily extended with a custom editor for your specific type beside standard supported types such as String, Integer, DateTime and so on.

SilkierQuartz was created with Semantic UI and Handlebars.Net as the template engine.

Packages

Package Description Version Downloads
SilkierQuartz Main web UI package for Quartz.NET management, including dashboard, job editing, trigger management, and execution monitoring. NuGet version NuGet downloads
SilkierQuartz.Plugins.RecentHistory Core recent-history plugin that records execution history and supports centralized relational persistence through the provider-agnostic registration API. NuGet version NuGet downloads
SilkierQuartz.Plugins.RecentHistory.EFCoreSqlServer EF Core SQL Server history store package with ready-to-use AddEfCoreExecutionHistoryStore(...) registration for Microsoft SQL Server deployments. NuGet version NuGet downloads
SilkierQuartz.Plugins.RecentHistory.EFCoreNpgsql EF Core PostgreSQL history store package for teams using Npgsql and wanting the same execution-history behavior on PostgreSQL. NuGet version NuGet downloads
SilkierQuartz.Plugins.RecentHistory.EFCoreSqlite EF Core SQLite history store package for lightweight or embedded deployments that want persistent recent job history. NuGet version NuGet downloads
SilkierQuartz.Plugins.RecentHistory.EFCoreMySql EF Core MySQL history store package for MySQL-compatible deployments using the Pomelo provider. NuGet version NuGet downloads

Choose the package that matches your storage model:

SilkierQuartz’s Features

Quartzmin’s Features

Install

SilkierQuartz is available on nuget.org

To install SilkierQuartz, run the following command in the Package Manager Console

PM> Install-Package SilkierQuartz

To persist recent execution history with EF Core, install the matching provider package:

PM> Install-Package SilkierQuartz.Plugins.RecentHistory.EFCoreSqlServer
PM> Install-Package SilkierQuartz.Plugins.RecentHistory.EFCoreNpgsql
PM> Install-Package SilkierQuartz.Plugins.RecentHistory.EFCoreSqlite
PM> Install-Package SilkierQuartz.Plugins.RecentHistory.EFCoreMySql

ASP.NET Core middleware

Add to your Program.cs file:

   public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                })
             .ConfigureSilkierQuartzHost();
     }

Add to your Startup.cs file:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSilkierQuartz();
    services.AddExecutionHistoryStore(setting =>
        setting.UseSqlite("Data Source=silkierquartz-history.db"));
}

public void Configure(IApplicationBuilder app)
{
    /* Optional for authentication
    app.UseAuthentication();
    app.AddSilkierQuartzAuthentication();
    app.UseAuthorization();
    */
    app.UseSilkierQuartz(new SilkierQuartzOptions()
                {
                    Scheduler = scheduler,
                    VirtualPathRoot = "/SilkierQuartz",
                    UseLocalTime = true,
                    DefaultDateFormat = "yyyy-MM-dd",
                    DefaultTimeFormat = "HH:mm:ss"
                    /* Optional for authentication
                    AccountName = "Your User Name",
                    AccountPassword = "Your User Password",
                    IsAuthenticationPersist = false
                    */
                });
}

For applications that already manage their own ADO.NET provider factory, you can also configure the centralized execution history store through the generic provider interface:

services.AddExecutionHistoryStore(setting =>
    setting.UseAdoProvider(
        providerInvariantName: "Microsoft.Data.SqlClient",
        connectionString: configuration.GetConnectionString("QuartzHistory"),
        providerFactory: SqlClientFactory.Instance));

Notes

In clustered environments, you can now register a centralized execution history store directly with AddExecutionHistoryStore(...). SilkierQuartz will automatically enable ExecutionHistoryPlugin, and if no external store is configured the plugin falls back to the existing in-process history store.

License

This project is made available under the MIT license. See LICENSE for details.