Skip to content

Latest commit

 

History

History
343 lines (273 loc) · 12.6 KB

readme.md

File metadata and controls

343 lines (273 loc) · 12.6 KB
Raw

Crystal Quartz Panel is a lightweight, completely pluggable module for displaying Quartz.NET scheduler jobs information.

CI Build Join the chat at https://gitter.im/guryanovev/CrystalQuartz

View Demo (serverless, Quartz.NET scheduler is emulated in the browser)

Features

  • simple and lightweight, could be embedded into existing application:
    • supports OWIN-based web or standalone applications;
    • supports non-OWIN web applications;
    • native support for ASP.NET Core (without OWIN).
  • displays basic scheduler information:
    • scheduler state and properties;
    • triggers by jobs and groups;
    • job properties (JobDataMap);
  • ability to perform basic scheduler actions:
    • pause/resume/delete triggers, jobs or groups;
    • start/shutdown/standby/resume a scheduler;
    • execute a job on demand ("Trigger Now");
    • add a trigger for jobs;
  • easy integration with a remote scheduler (see examples);
  • works with Quartz.NET v2 or v3.

Pre Requirements

  1. Quartz.NET v2 or v3 installed to project you want to use as a CrystalQuartz panel host.

    CrystalQuartz detects Quartz.dll version at runtime and does not explicitly depend on Quartz NuGet package. So you need to make sure you have Quartz pre-installed.

    For Quartz 3:

    Install-Package Quartz -Version 3.6.2

    For Quartz 2:

    Install-Package Quartz -Version 2.6.2

  2. Make sure you have appropriate target framework version

    Minimum Supported .NET versions (vary by packages)

    Quartz.NET Version CrystalQuartz Package .NET Framework 4.0 .NET Framework 4.5 .NET Framework 4.5.2 .NET Standard 2.0 .NET Core 2.0 .NET 5
    v3 CrystalQuartz.AspNetCore ✔️ ✔️ ✔️
    v3 CrystalQuartz.Owin ✔️ ✔️ ✔️ ✔️
    v3 CrystalQuartz.Owin ✔️ ✔️ ✔️ ✔️
    v3 CrystalQuartz.Simple ✔️ ✔️ ✔️ ✔️
    v3 CrystalQuartz.Remote ✔️ ✔️ ✔️ ✔️
    v2 CrystalQuartz.Owin ✔️ ✔️ ✔️ ✔️ ✔️
    v2 CrystalQuartz.Simple ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
    v2 CrystalQuartz.Remote ✔️ ✔️ ✔️ ✔️ ✔️ ✔️

Getting started

CrystalQuartzPanel is an embeddable module that can be plugged into an existing application. Getting started strategy depends on a type of environment you use.

Option 1: ASP.NET Core (recommended for modern .NET environments)

This option should work for any modern .NET 5/6/7 and .NET Core 2/3 applications as long as they use ASP.NET Core hosting environment.

  1. Install NuGet package

    Install-Package CrystalQuartz.AspNetCore -IncludePrerelease

  2. Once you have an ASP.NET Core-supported application (no matter if it's web or self hosted) you can activate CrystalQuartz panel:

    using CrystalQuartz.AspNetCore;
// ...
/*
 * app is IApplicationBuilder
 * scheduler is your IScheduler (local or remote) or Task<IScheduler>
 */
app.UseCrystalQuartz(() => scheduler);

  3. Run your app and navigate to

    localhost:YOUR_PORT/quartz

Please check Getting Started with ASP.NET Core for more details.

Examples

Option 2: OWIN (legacy environments)

  1. Install NuGet package

    Install-Package CrystalQuartz.Owin -IncludePrerelease

  2. Once you have an OWIN-supporting application (no matter if it's web or self hosted) you can activate CrystalQuartz panel:

    using CrystalQuartz.Owin;
// ...
/*
 * app is IAppBuilder
 * scheduler is your IScheduler (local or remote)
 */
app.UseCrystalQuartz(() => scheduler);

  3. Run your app and navigate to

    localhost:YOUR_PORT/quartz

Please check Getting Started with OWIN for more details.

Examples

Option 3: Non-OWIN (ancient legacy)

Non-owin CrystalQuartzPanel implemented as an http module. It can work in web-applications only and requires some configuration to be added to the web.config file. There are two NuGet packages aimed to help in case of non-owin application, the choice depends on the type of scheduler you use.

Option 2.1: If Quartz Scheduler works in the app domain of your web application:

  1. Install CrystalQuartz.Simple NuGet package.

    Install-Package CrystalQuartz.Simple -IncludePrerelease

  2. Customize SimpleSchedulerProvider class that has been added by NuGet package

    public class SimpleSchedulerProvider : ISchedulerProvider
{
    public object CreateScheduler(ISchedulerEngine engine)
    {
        ISchedulerFactory schedulerFactory = new StdSchedulerFactory();
        var scheduler = GetScheduler(schedulerFactory.GetScheduler());

        /* ADD JOBS HERE */
  
        return scheduler;
    }
    //...
}

  3. Run you application and go to YOUR_APP_URL/CrystalQuartzPanel.axd

Option 2.2: If Quartz Scheduler works in a separate application (remote scheduler):

  1. Install CrystalQuartz.Remote NuGet package.

    Install-Package CrystalQuartz.Remote -IncludePrerelease

  2. Customize url of the remote scheduler in web config file:

    <crystalQuartz>
    <provider>
        <add property="Type" 
             value="CrystalQuartz.Core.SchedulerProviders.RemoteSchedulerProvider, CrystalQuartz.Core" />
        <add property="SchedulerHost" 
             value="tcp://localhost:555/QuartzScheduler" /> <!-- Customize URL here -->
    </provider>
</crystalQuartz>

  3. Run you application and go to YOUR_APP_URL/CrystalQuartzPanel.axd

Examples

Advanced Configuration

CrystalQuartz supports some configuration options that could be passed to the panel at startup time to customize it's behavior.

For CrystalQuartz.Owin package pass options to UseCrystalQuartz method:

using CrystalQuartz.Application;

//...

app.UseCrystalQuartz(
    () => scheduler,
    new CrystalQuartzOptions
    {
        /* SET OPTIONS HERE */
    });

For CrystalQuartz.Simple and CrystalQuartz.Remote use the web.config:

<sectionGroup name="crystalQuartz" type="CrystalQuartz.Web.Configuration.CrystalQuartzConfigurationGroup">
  <section 
      name="provider" 
      type="CrystalQuartz.Web.Configuration.ProviderSectionHandler" 
      requirePermission="false" 
      allowDefinition="Everywhere" />
  <!-- options section is required -->
  <section 
      name="options" 
      type="CrystalQuartz.Web.Configuration.CrystalQuartzOptionsSection" 
      requirePermission="false" 
      allowDefinition="Everywhere" />
</sectionGroup>

<!-- ... -->
<crystalQuartz>
  <!-- ... -->
  <!-- PLACE OPTIONS HERE -->
  <options
      customCssUrl="CUSTOM_CSS_URL">
  </options>
</crystalQuartz>

Advanced configuration topics:

List of available options:

Property Name XML Attribute Default
Path not supported 'quartz' Url part for the panel.
CustomCssUrl customCssUrl null Valid absolute or relative url for custom CSS styles for the panel. See custom styles example for details.
LazyInit not supported false A flag indicating whether CrystalQuartz Panel should be initialized immediately after application start (false) or after first call of panel services (true).
TimelineSpan not supported 1 hour Span of timeline events displayed by the panel.

Please note: The options list here is not complete, please check the options class source code for details.

Building from source

Please use Build.bat script to build the project locally. Rebuilding directly from Visual Studio would not work correctly because some client-side assets should be regenerated. Build.bat is a bootstrapper for Rosalia build tool. Prerquirements:

  • NodeJs and npm should be installed on your machine and globally available.

Once the build completes successfully, you can Run the VS project as usually.

Collaboration

Please use gitter to ask questions. Fill free to report issues and open pull requests.

Changelog

Latest update:

  • timeline tooltip cosmetic fixes
  • introduced trigger fire details dialog (opens on timeline item click)

See full changelog