PFA.Hangfire.RecurringJobAdmin 1.0.6-beta01

This is a prerelease version of PFA.Hangfire.RecurringJobAdmin.
There is a newer version of this package available.
See the version list below for details.
dotnet add package PFA.Hangfire.RecurringJobAdmin --version 1.0.6-beta01                
NuGet\Install-Package PFA.Hangfire.RecurringJobAdmin -Version 1.0.6-beta01                
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="PFA.Hangfire.RecurringJobAdmin" Version="1.0.6-beta01" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PFA.Hangfire.RecurringJobAdmin --version 1.0.6-beta01                
#r "nuget: PFA.Hangfire.RecurringJobAdmin, 1.0.6-beta01"                
#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 PFA.Hangfire.RecurringJobAdmin as a Cake Addin
#addin nuget:?package=PFA.Hangfire.RecurringJobAdmin&version=1.0.6-beta01&prerelease

// Install PFA.Hangfire.RecurringJobAdmin as a Cake Tool
#tool nuget:?package=PFA.Hangfire.RecurringJobAdmin&version=1.0.6-beta01&prerelease                

Hangfire.RecurringJobAdmin

NuGet Build status Build Status Official Site License MIT

dashboard

A simple dashboard to manage Hangfire's recurring jobs.

This repo is an extension for Hangfire based on "Hangfire.Recurring Job Extensions" package made by vigoss, thanks for your contribution to the community. It contains the following functionalities:

  • We can use RecurringJobAttribute stored in database and presented in the administrator.
public class RecurringJobTesting
{
    [RecurringJob("*/2 * * * *", "China Standard Time", "default", RecurringJobId = "Check-File-Exists")]
    public void CheckFileExists()
    {
       Console.WriteLine("Check File Exists");
    }
}
  • We can use DisableConcurrentlyJobExecution, this attribute allows you to not execute a task if it is already running.
public class RecurringJobTesting
{
    [DisableConcurrentlyJobExecution("CheckFileExists")]
    public void CheckFileExists()
    {
       Console.WriteLine("Check File Exists");
    }
    
    [DisableConcurrentlyJobExecution("ValidateProcess", 0, 10, "It is not allowed to perform multiple same tasks.")]
    [RecurringJob("*/2 * * * *", "China Standard Time", "default", RecurringJobId = "Validate-Process")]
    public void ValidateProcess()
    {
        Console.WriteLine("Validate Process");
    }
}
  • We can create, edit jobs.

create

  • We can start, stop jobs at runtime.

jobAgent

  • So we can also start or stop the job using JobAgent static class.

   JobAgent.StopBackgroundJob("Enter the Job Id");
   
   JobAgent.StartBackgroundJob("Enter the Job Id");
   
   //Get all stopped jobs:
   var StoppedJobs = JobAgent.GetAllJobStopped();
   
  • We have a new vue component to generate cron expression, made by @JossyDevers.

jobAgent

Instructions

Install a package from Nuget.

Install-Package Hangfire.RecurringJobAdmin

Then add this in your code:

For DotNetCore :

for service side:

services.AddHangfire(config => config.UseSqlServerStorage(Configuration.GetConnectionString("HangfireConnection"))
                                                 .UseRecurringJobAdmin(typeof(Startup).Assembly))

For NetFramework :

for startup side:

GlobalConfiguration.Configuration.UseSqlServerStorage("HangfireConnection").UseRecurringJobAdmin(typeof(Startup).Assembly)

Credits

  • Braulio Alvarez

Donation

If this project help you reduce time to develop, you can give me a cup of coffee 😃

paypal

License

Authored by: Brayan Mota (bamotav)

This project is under MIT license. You can obtain the license copy here.

Product 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 was computed. 
.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. 
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
1.0.6 4,648 9/21/2023
1.0.6-beta01 106 9/21/2023

* Support job methods returning Task<TReturn>
* Improve line breaking