Quartz Scheduler Extension for Lucee

A powerful scheduling extension for Lucee 6.2 and 7, built on the industry-standard Quartz Scheduler library. The extension is written entirely in CFML (100%), showcasing the power and flexibility of the language.

Overview

The Quartz Scheduler extension brings industry-standard scheduling capabilities to Lucee, leveraging the most widely adopted scheduling system in the Java world. Starting with Lucee 7, it serves as the modern replacement for the legacy Scheduled Task system.

Key Features

• Multiple Job Types: Schedule URL calls, server-local paths, or CFML component executions
• Clustering Support: Distribute scheduled tasks across multiple servers using database or Redis persistence
• Flexible Scheduling: Simple interval-based scheduling or powerful cron expressions
• Event Listeners: Attach listener components to monitor job execution
• JSON Configuration: Define tasks using flexible JSON configuration
• Component Integration: Execute CFML components as scheduled tasks with dependency injection
• Lucee Administrator Integration: Full-featured frontend for managing jobs, listeners, and storage settings

Requirements

• Lucee 6.2 (experimental) or Lucee 7 (fully supported)

Installation

Using the Lucee Administrator

1. Navigate to Extensions > Available Extensions
2. Find "Quartz Scheduler" in the list
3. Click "Install"

Manual Installation

1. Download the extension from download.lucee.org
2. Copy the .lex file to the Lucee deploy folder: lucee-server/deploy
3. Lucee will automatically detect and install the extension within a minute

Via .CFConfig.json

You can also define the extension in your .CFConfig.json so it is installed automatically when Lucee starts.

From a local .lex file:

"extensions": [
  {
    "id": "E99E43A5-C10E-41E9-878BFC82BAAD99CE",
    "name": "Quartz Scheduler Extension",
    "resource": "${EXTENSION_PATH}/quartz-extension-1.0.0.48.lex"
  }
]

Downloaded automatically from Maven:

"extensions": [
  {
    "id": "E99E43A5-C10E-41E9-878BFC82BAAD99CE",
    "name": "Quartz Scheduler Extension",
    "version": "1.0.0.48"
  }
]

When only id and version are provided, Lucee will download the extension directly from Maven at startup.

Configuration

The scheduler is configured via JSON, stored at:

{lucee-server}/lucee-server/context/quartz/config.json

Basic Example

{
  "jobs": [
    {
      "label": "External API Call",
      "url": "https://api.example.com/daily-report",
      "cron": "0 0 8 * * ?",
      "pause": false
    },
    {
      "label": "Database Maintenance",
      "component": "com.example.tasks.DatabaseMaintenance",
      "cron": "0 0 3 ? * SUN",
      "mode": "singleton"
    }
  ],
  "listeners": [
    {
      "component": "com.example.scheduler.ExecutionListener",
      "stream": "err"
    }
  ]
}

Clustering Example

{
  "primary": "store",
  "store": {
    "type": "datasource",
    "datasource": "quartz",
    "tablePrefix": "QRTZ_",
    "cluster": true,
    "clusterCheckinInterval": "15000",
    "misfireThreshold": "60000"
  }
}

The primary setting controls which source is authoritative for job definitions:

Value	Behaviour
"store" (default when store is defined)	The store is the source of truth. The config file seeds initial jobs only when the store is empty.
"file" (default when no store is defined)	The config file is always authoritative. Jobs missing from the file are removed from the store on startup.

Documentation

Full documentation is available in the Lucee docs:

• Quartz Scheduler — overview, configuration reference, job types, and component jobs
• Clustering with Quartz Scheduler — database and Redis setup, primary/replica configuration, troubleshooting
• Component-Based Jobs — creating and configuring CFC-based jobs and listeners

Feedback and Contribution

Issues and suggestions are welcome on the issue tracker.