Quartz.NETQuartz.NET
Home
Features
Blog
Discussions
NuGet
GitHub
Home
Features
Blog
Discussions
NuGet
GitHub
  • Getting Started

    • Overview
    • Quartz 4 Quick Start
    • Tutorial
      • Using Quartz
      • Jobs And Triggers
      • More About Jobs & JobDetails
      • Job Data
      • More About Triggers
      • Querying Jobs and Triggers
      • Simple Triggers
      • Cron Triggers
      • RecurrenceTrigger
      • Time and TimeProvider
      • Trigger and Job Listeners
      • Scheduler Listeners
      • Job Execution Middleware
      • Job Stores
      • Configuration, Resource Usage and Building a Scheduler
      • Building a Scheduler Without a Host
      • Clustering
      • Execution Groups
      • Node Affinity (Preferred Node)
      • Testing
    • Configuration Reference
    • JSON Configuration
    • Cron Expression Reference
    • Multi-Tenancy
    • Frequently Asked Questions
    • Best Practices
    • Before You Go Live
    • Operating a Cluster
    • Log Events
    • Tenancy Patterns
    • Database Schema
    • Database Schema Changes
    • Migration Guide
    • Troubleshooting
    • API Documentation
  • How To's
    • One-Off Job
    • Rescheduling Jobs
    • Retrying Failed Jobs
    • Multiple Triggers
    • Job Template
    • Running Quartz under Aspire
    • Quartz.NET with Wolverine
    • Embedding Quartz in a Library
    • Running under an External Leader Election
    • Publishing Trimmed and Native AOT
    • Extending Quartz: what is open, what is closed, and how to ask
    • A Job Store of Your Own
    • A Driver Delegate for a New Database
    • Persisting a Custom Trigger Type
    • A Lock Handler of Your Own
  • Packages

    • Quartz Core Additions

      • Jobs
      • Serialization (System.Text.Json)
      • JSON Serialization
      • Plugins
    • Integrations

      • Aspire Integration
      • ASP.NET Core Integration
      • HTTP API
      • HTTP Client
      • Dashboard
      • Hosted Services Integration
      • Microsoft DI Integration
      • Multiple Schedulers with Microsoft DI
      • Observability
      • Redis Lock Handler
      • TimeZoneConverter Integration
    • 3rd Party Plugins for Quartz
  • Quartz 3.x

    • Getting Started

      • Quartz 3 Quick Start
      • Tutorial
        • Using Quartz
        • Library Overview
        • Jobs And Triggers
        • More About Jobs
        • More About Triggers
        • Execution Groups
        • Node Affinity (Preferred Node)
        • Simple Triggers
        • Cron Triggers
        • RecurrenceTrigger
        • Trigger and Job Listeners
        • Scheduler Listeners
        • Job Stores
        • Tuning the Scheduler
        • Configuration, Resource Usage and SchedulerFactory
        • Advanced (Enterprise) Features
      • Configuration Reference
      • JSON Configuration
      • Multi-Tenancy
      • Frequently Asked Questions
      • Best Practices
      • Tenancy Patterns
      • Troubleshooting
      • API Documentation
      • Database Schema
      • Database Schema Changes
      • Migration Guide
      • Miscellaneous Features
    • How To's

      • One-Off Job
      • Multiple Triggers
      • Job Template
      • Using the CronTrigger
      • Rescheduling Jobs
    • Packages

      • Quartz Core Additions

        • Dashboard
        • Jobs
        • Serialization (System.Text.Json)
        • Serialization (Newtonsoft Json.NET)
        • Plugins
      • Integrations

        • ASP.NET Core Integration
        • Hosted Services Integration
        • Microsoft DI Integration
        • Multiple Schedulers with Microsoft DI
        • OpenTelemetry Integration
        • OpenTracing Integration
        • Redis Lock Handler
        • TimeZoneConverter Integration
      • 3rd Party Plugins for Quartz
  • Old Releases

    • Quartz 2.x
      • Quartz 2 Quick Start
      • Tutorial
        • Lesson 1: Using Quartz
        • Lesson 2: Jobs And Triggers
        • Lesson 3: More About Jobs & JobDetails
        • Lesson 4: More About Triggers
        • Lesson 5: SimpleTrigger
        • Lesson 6: CronTrigger
        • Lesson 7: TriggerListeners and JobListeners
        • Lesson 8: SchedulerListeners
        • Lesson 9: JobStores
        • Lesson 10: Configuration, Resource Usage and SchedulerFactory
        • Lesson 11: Advanced (Enterprise) Features
        • Lesson 12: Miscellaneous Features of Quartz
        • CronTrigger Tutorial
      • Configuration Reference
      • Migration Guide
      • API Documentation
    • Quartz 1.x
      • Tutorial
        • Lesson 1: Using Quartz
        • Lesson 2: Jobs And Triggers
        • Lesson 3: More About Jobs & JobDetails
        • Lesson 4: More About Triggers
        • Lesson 5: SimpleTrigger
        • Lesson 6: CronTrigger
        • Lesson 7: TriggerListeners and JobListeners
        • Lesson 8: SchedulerListeners
        • Lesson 9: JobStores
        • Lesson 10: Configuration, Resource Usage and SchedulerFactory
        • Lesson 11: Advanced (Enterprise) Features
        • Lesson 12: Miscellaneous Features of Quartz
      • API Documentation
  • License

JSON Configuration

Quartz.NET supports hierarchical JSON configuration in appsettings.json, providing a modern alternative to flat property keys. This includes both scheduler properties and declarative job/trigger definitions.

Tips

JSON configuration support is included in the core Quartz package. See the Configuration Reference for the full option index.

Hierarchical Properties

Instead of flat property keys like "quartz.threadPool.maxConcurrency": "10", you can use a natural nested JSON structure:

{
  "Quartz": {
    "Scheduler": {
      "InstanceName": "My Scheduler",
      "InstanceId": "AUTO"
    },
    "ThreadPool": {
      "MaxConcurrency": 10
    },
    "JobStore": {
      "Type": "Quartz.Impl.AdoJobStore.LocalTransactionJobStore, Quartz",
      "DataSource": "default",
      "TablePrefix": "QRTZ_"
    },
    "DataSource": {
      "default": {
        "Provider": "SqlServer",
        "ConnectionString": "Server=localhost;Database=quartznet"
      }
    },
    "Plugin": {
      "jobHistory": {
        "Type": "Quartz.Plugins.History.LoggingJobHistoryPlugin, Quartz.Plugins"
      }
    },
    "Serializer": {
      "Type": "stj"
    }
  }
}

Mapping Rules

Each JSON path segment becomes a dot-separated segment in the flat property key, with PascalCase automatically converted to camelCase:

JSON PathFlat Property Key
Scheduler:InstanceNamequartz.scheduler.instanceName
ThreadPool:MaxConcurrencyquartz.threadPool.maxConcurrency
DataSource:default:Providerquartz.dataSource.default.provider
Plugin:jobHistory:Typequartz.plugin.jobHistory.type

Usage with DI

services.AddQuartz(Configuration.GetSection("Quartz"), q =>
{
    // Additional code-based configuration still works alongside JSON
    q.AddJob<MyJob>(j => j.WithIdentity("codeJob").StoreDurably());
});

Usage without DI

QuartzSchedulerBuilder reads the same section. There is no flattening step to write: hand it the IConfiguration and it binds the typed options and translates the flat keys itself, exactly as AddQuartz does.

ISchedulerFactory factory = QuartzSchedulerBuilder.Create()
    .UseConfiguration(Configuration.GetSection("Quartz"))
    .Build();

A NameValueCollection you built yourself — from a properties file, from environment variables — still goes in through UseProperties(properties).

Backward Compatibility

Flat property keys still work. You can mix both styles in the same section:

{
  "Quartz": {
    "quartz.scheduler.instanceId": "AUTO",
    "ThreadPool": {
      "MaxConcurrency": 10
    }
  }
}

JSON Scheduling Data

Jobs and triggers can be defined declaratively in appsettings.json under a Schedule sub-section:

{
  "Quartz": {
    "Scheduler": {
      "InstanceName": "My Scheduler"
    },
    "Schedule": {
      "Jobs": [
        {
          "Name": "sampleJob",
          "Group": "sampleGroup",
          "JobType": "MyApp.Jobs.SampleJob, MyApp",
          "Description": "A sample job",
          "Durable": true,
          "Recover": false,
          "JobDataMap": {
            "connectionString": "Server=localhost",
            "retryCount": "3"
          }
        }
      ],
      "Triggers": [
        {
          "Name": "cronTrigger",
          "JobName": "sampleJob",
          "JobGroup": "sampleGroup",
          "Description": "Fires every 10 seconds",
          "Cron": {
            "Expression": "0/10 * * * * ?",
            "TimeZone": "UTC"
          }
        }
      ]
    }
  }
}

Trigger Types

Exactly one schedule type must be specified per trigger — Simple, Cron, CalendarInterval, DailyTimeInterval or Recurrence. The trigger type is determined by which nested object is present.

Simple Trigger

{
  "Name": "simpleTrigger",
  "JobName": "myJob",
  "Simple": {
    "RepeatCount": -1,
    "Interval": "00:00:10",
    "MisfireInstruction": "SmartPolicy"
  }
}
  • RepeatCount: Number of times to repeat. Use -1 for indefinite, 0 for fire once.
  • Interval: TimeSpan string (e.g., "00:00:10" for 10 seconds, "01:00:00" for 1 hour).

Cron Trigger

{
  "Name": "cronTrigger",
  "JobName": "myJob",
  "Cron": {
    "Expression": "0/30 * * * * ?",
    "TimeZone": "America/New_York",
    "MisfireInstruction": "DoNothing"
  }
}

Calendar Interval Trigger

{
  "Name": "calendarTrigger",
  "JobName": "myJob",
  "CalendarInterval": {
    "RepeatInterval": 1,
    "RepeatIntervalUnit": "Day",
    "MisfireInstruction": "SmartPolicy"
  }
}

RepeatIntervalUnit values: Second, Minute, Hour, Day, Week, Month, Year.

Daily Time Interval Trigger

{
  "Name": "businessHoursTrigger",
  "JobName": "myJob",
  "DailyTimeInterval": {
    "RepeatInterval": 15,
    "RepeatIntervalUnit": "Minute",
    "RepeatCount": -1,
    "StartTimeOfDay": "08:00:00",
    "EndTimeOfDay": "17:00:00",
    "DaysOfWeek": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"],
    "TimeZone": "America/Chicago"
  }
}

Recurrence Trigger

{
  "Name": "recurrenceTrigger",
  "JobName": "myJob",
  "StartTime": "2026-01-05T09:00:00Z",
  "Recurrence": {
    "Rule": "FREQ=WEEKLY;INTERVAL=2;BYDAY=MO",
    "TimeZone": "America/New_York",
    "MisfireInstruction": "DoNothing"
  }
}
  • Rule: the RFC 5545 recurrence rule, required. See Recurrence Triggers for what a rule can say.
  • TimeZone: the zone the rule's days and times are read in. Defaults to the machine's local zone, so name it if the schedule has to mean the same thing wherever it runs.
  • MisfireInstruction: SmartPolicy (the default), FireOnceNow, DoNothing or IgnoreMisfirePolicy.

The rule says how the firings repeat; the trigger's own StartTime says what they repeat from, the way DTSTART anchors an iCalendar rule. FREQ=WEEKLY;INTERVAL=2 therefore means "every second week counted from the start time", and a trigger given no StartTime is anchored to the moment its scheduler read the declaration. A rule that cannot be parsed is refused as the file is read, naming the rule, rather than at the first firing.

Tips

This trigger kind is JSON only. The XML format is frozen at the three trigger kinds its schema already declares and will not gain a <recurrence> element, so a recurrence rule is declared in JSON or written in code.

Common Trigger Fields

All trigger types support these optional fields:

FieldDescription
NameTrigger name (required)
GroupTrigger group (defaults to DEFAULT)
JobNameAssociated job name (required)
JobGroupAssociated job group (defaults to DEFAULT)
DescriptionTrigger description
PriorityTrigger priority (integer)
CalendarNameCalendar to apply
ExecutionGroupThe trigger's execution group
RetryPolicyThe trigger's retry policy in its stored form, for example fixed;3;00:00:30
PreferredNodeThe cluster node the trigger prefers: a scheduler instance id, or "*" to pin it to whichever node fires it first. Omitted leaves it unpinned
StartTimeISO 8601 start time (e.g., "2024-01-01T00:00:00Z")
StartTimeSecondsInFutureStart time as seconds from now (mutually exclusive with StartTime)
EndTimeISO 8601 end time
JobDataMapKey-value pairs for the trigger's data map

PreferredNode is the one that says something about the deployment rather than about the schedule, and declaring it in a file is what a deployment-specific file is for: every machine that reads the file pins the trigger to the node it names, which is the point of pinning it at all.

{
  "Name": "nightlyReport",
  "JobName": "reportJob",
  "PreferredNode": "production-node-1",
  "Cron": { "Expression": "0 0 2 * * ?" }
}

Warning

The name is a scheduler instance id and must match one exactly — pin comparisons happen in SQL using the database's string collation, so a value differing only in case is a different node, and on a case-sensitive database one that never matches. A file naming a node that no longer exists pins the trigger to nothing, and the trigger stops firing until the node comes back, the pin is cleared or the file is corrected. "*" avoids naming a node at all: the first node to fire the trigger claims it and keeps it, and the pin is released if that node stops checking in.

The same field is spelled <preferred-node> in the XML format.

Multiple Named Schedulers

When the Quartz section contains a Schedulers sub-section, each child is automatically registered as a named scheduler:

{
  "Quartz": {
    "Schedulers": {
      "Primary": {
        "Scheduler": {
          "InstanceId": "AUTO"
        },
        "ThreadPool": {
          "MaxConcurrency": 10
        },
        "Schedule": {
          "Jobs": [
            {
              "Name": "primaryJob",
              "JobType": "MyApp.Jobs.PrimaryJob, MyApp",
              "Durable": true
            }
          ],
          "Triggers": [
            {
              "Name": "primaryTrigger",
              "JobName": "primaryJob",
              "Cron": { "Expression": "0/10 * * * * ?" }
            }
          ]
        }
      },
      "Secondary": {
        "ThreadPool": {
          "MaxConcurrency": 5
        }
      }
    }
  }
}
// Registers "Primary" and "Secondary" named schedulers automatically
services.AddQuartz(Configuration.GetSection("Quartz"));
services.AddQuartzHostedService();

Each named scheduler section supports the same hierarchical properties, Schedule sub-section with Jobs/Triggers, and code-based overrides.

You can also register a single named scheduler explicitly. The named overload accepts either the scheduler's own section or the root Quartz section — when given the root section it resolves the matching Schedulers:{name} sub-section automatically:

// Both lines are equivalent
services.AddQuartz("Primary", Configuration.GetSection("Quartz"));
services.AddQuartz("Primary", Configuration.GetSection("Quartz:Schedulers:Primary"));

Warning

Defining both a Schedulers sub-section and direct scheduler configuration (e.g., Scheduler, ThreadPool at the top level) is an error. Use one or the other. A top-level Schedule/Scheduling section cannot be combined with Schedulers either — move it under the appropriate Schedulers:{name} entry.

Standalone JSON Files (quartz_jobs.json)

For file-based scheduling with hot-reload support, use JsonSchedulingDataProcessorPlugin from the Quartz.Plugins package. See Quartz Plugins for plugin configuration.

Standalone JSON files use the same Jobs and Triggers format as the Schedule section above, wrapped in an envelope with optional PreProcessingCommands and ProcessingDirectives:

{
  "PreProcessingCommands": {
    "DeleteJobsInGroup": ["obsoleteGroup"],
    "DeleteTriggersInGroup": ["oldTriggerGroup"],
    "DeleteJobs": [
      { "Name": "oldJob", "Group": "DEFAULT" }
    ],
    "DeleteTriggers": [
      { "Name": "oldTrigger" }
    ]
  },
  "ProcessingDirectives": {
    "OverwriteExistingData": true,
    "IgnoreDuplicates": false,
    "ScheduleTriggerRelativeToReplacedTrigger": false
  },
  "Schedule": {
    "Jobs": [
      {
        "Name": "myJob",
        "JobType": "MyApp.Jobs.MyJob, MyApp",
        "Durable": true
      }
    ],
    "Triggers": [
      {
        "Name": "myTrigger",
        "JobName": "myJob",
        "Cron": {
          "Expression": "0/30 * * * * ?"
        }
      }
    ]
  }
}

PreProcessingCommands

Commands executed before scheduling. All fields are optional:

FieldDescription
DeleteJobsInGroupArray of group names. Use "*" to delete jobs in all groups.
DeleteTriggersInGroupArray of group names. Use "*" to delete triggers in all groups.
DeleteJobsArray of { "Name": "...", "Group": "..." } objects. Group is optional.
DeleteTriggersArray of { "Name": "...", "Group": "..." } objects. Group is optional.

ProcessingDirectives

FieldDefaultDescription
OverwriteExistingDatatrueReplace existing jobs/triggers with the same identity. The default applies only when the file does not carry IgnoreDuplicates.
IgnoreDuplicatesfalseSilently skip duplicates instead of erroring. A file that carries this and no OverwriteExistingData directive gets overwriting turned off.
ScheduleTriggerRelativeToReplacedTriggerfalseAdjust new trigger timing based on old trigger's last fire time.

Declaring one key twice in a file is an error

Every directive above describes how the file relates to the scheduler. None of them describes how the file relates to itself, so none of them suppresses the error a file gets for declaring one job or trigger key — name and group — twice:

Trigger 'DEFAULT.myTrigger' is defined more than once in the scheduling data.

The same holds for the XML format's <overwrite-existing-data> and <ignore-duplicates>. Before Quartz.NET 4, the last definition of a repeated key won and said so only at Debug.

When a file is wrong

Two settings on the plugin decide what a bad file does, and they answer different questions. Both are on FileSchedulingOptions, and everything below is the same for the XML format.

A file that is not there. FailOnFileNotFound is true by default, so a named file that does not exist stops the scheduler being built, with a SchedulerException naming it:

File named 'quartz_jobs.json' does not exist.

Set it to false and the file is logged as missing and skipped, which is what an optional overlay file wants.

A file that is there and is wrong. Whatever went wrong — malformed JSON, a trigger with two schedule blocks, a JobType that will not load, a key declared twice — the processor raises it, the plugin logs it, wraps it in a SchedulerException naming the file, and hands that to every registered ISchedulerListener through SchedulerError. It is rethrown only when FailOnSchedulingError is true, and that setting is false by default: the scheduler otherwise starts without the schedule the file was carrying. Turn it on where a schedule that failed to load should stop the deployment instead of running a scheduler with nothing in it.

Which exception, and why it matters. Quartz.SchedulingDataValidationException — a SchedulerException — is the one that carries every violation it found rather than the first: ValidationExceptions is the list and Message is every message, one per line. A document is checked against the schema, and its keys checked for duplicates, before any of it is applied, so a file with three mistakes in it reports three. Everything else a file can get wrong is an ordinary SchedulerException raised where it happens — a JobType that will not load, a non-durable job with no trigger — so it names the one thing that failed.

Neither makes the file a transaction against the store. PreProcessingCommands have already run by the time a job is stored, and a document with several jobs applies them one at a time.

Help us by improving this page!
Last Updated: 9/11/26, 7:37 PM
Contributors: Marko Lahma, Claude Fable 5.1
Prev
Configuration Reference
Next
Cron Expression Reference