coldbox-scheduled-tasks

Automates configuration and orchestration of ColdBox Scheduler tasks.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill coldbox-scheduled-tasks
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coldbox-scheduled-tasks
Source: https://github.com/ColdBox/skills/tree/main/coldbox/scheduled-tasks
Command: npx skills add https://github.com/ColdBox/skills --skill coldbox-scheduled-tasks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

ColdBox requires structured scheduling for background tasks; this skill centralizes the creation and management of global and module schedulers, lifecycle handling, and cluster-aware execution.

Core Features & Use Cases

  • Global Scheduler: config/Scheduler.cfc with a configure() method discovered by ColdBox.
  • Module Scheduler: module-level Scheduler.cfc files discovered via ModuleConfig.
  • Task DSL: register tasks with a fluent API and lifecycle hooks (onStartup, onShutdown, onAnyTaskError, onAnyTaskSuccess).
  • Server fixation: coordinate tasks across clustered deployments to run once per cluster or across environments.

Quick Start

Create a global Scheduler.cfc in config and register a simple recurring task using the task DSL.

Frequently Asked Questions about coldbox-scheduled-tasks

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up scheduled tasks in a ColdBox application?

To set up ColdBox scheduled tasks, create a global config/Scheduler.cfc with a configure() method and use the task DSL to register recurring tasks. Module-level schedulers can be added via Scheduler.cfc files in ModuleConfig.

How does cluster-aware execution work for CFML background tasks?

Cluster-aware execution uses server fixation to coordinate tasks across clustered deployments, ensuring tasks run once per cluster or across environments. This prevents duplicate background processing in distributed systems.

Can I handle task lifecycle events like startup and shutdown in ColdBox schedulers?

Yes, ColdBox schedulers support lifecycle hooks including onStartup, onShutdown, onAnyTaskError, and onAnyTaskSuccess. These hooks allow you to manage task execution state and handle errors globally within the scheduler configuration.

What is the difference between global and module schedulers in ColdBox?

Global schedulers are defined in config/Scheduler.cfc and handle application-wide tasks, while module schedulers are defined in individual module Scheduler.cfc files discovered via ModuleConfig for modular task isolation.

Do I need an existing ColdBox project to use the scheduler automation?

Yes, you need an existing ColdBox project with a global config/Scheduler.cfc file. Optional module Scheduler.cfc files and lifecycle or clustering configurations can be added depending on your task orchestration requirements.