Provides a programmatic interface to the CFML scheduling engine. Can run a CFML page at scheduled intervals, with the option to write the page output to a static HTML page. This feature enables you to schedule pages that publish data, such as reports, without waiting while a database transaction is performed to populate the page.
delete: deletes the specified task update: updates an existing task or creates a new task, if one with the name specified by the task attribute does not exist run: executes the specified task pause: Pauses the specified task. resume: Continues executing the specified task. list: Lists all the scheduled tasks. pauseall: CF 10+ Pauses all scheduled tasks. resumeall: CF 10+ Resume all scheduled tasks for a particular application. create: CF2018u2+ Create a fresh task. If a task already exists, an error is thrown. modify: CF2018u2+ Modifies an existing task while retaining its old values.
Name of the task. Not required if action attribute is set to list, otherwise it is required.
Operation that the scheduler performs. Must be HTTPRequest.
Name of the file in which to store the published output of the scheduled task.
Path to the directory in which to put the published file. NOTE: This is Required if publish is "Yes".
Date on which to first run the scheduled task.
Time at which to run the scheduled of task starts.
URL of the page to execute.
Port to use on the server that is specified by the url parameter. If resolveURL = "yes", retrieved document URLs that specify a port number are automatically resolved, to preserve links in the retrieved document. A port value in the url attribute overrides this value.
Yes: save the result to a file No: does not
Date when scheduled task ends.
Time when scheduled task ends (seconds).
Interval at which task is scheduled. * number of seconds (minimum is 60) * once * daily * weekly * monthly
Deprecated as of CF 11+, Removed in CF2018 Used to extend the default timeout period.
Username, if URL is protected.
Password, if URL is protected.
Host name or IP address of a proxy server.
Port number to use on the proxy server.
User name to provide to the proxy server.
Password to provide to the proxy server.
Yes: resolve links in the output page to absolute references No: does not
CF 11+ The group to which the scheduled task belongs.
CF 10+ If the task is server-specific or application specific.
result (CF10+)/returnvariable (lucee)
Name for the query in which cfschedule returns the result variables. NOTE: Required for action="list"
CF 10+ A CFC file which implements CFIDE.scheduler.ITaskEventHandler and is invoked for events while running the task. Note: CF 2018 Enterprise Required; not supported in Standard Edition
Default:invokeHandler, if eventHandler is specified
CF 10+ Specify the action to take if a task results in error. Note: CF 2018 Enterprise Required; not supported in Standard Edition
CF 10+ The action or task to perform after completion of the current task. Can be used to chain dependent tasks by executing a task after this task completes. Note: CF 2018 Enterprise Required; not supported in Standard Edition
Default:invokeHandler if eventHandler is specified
CF 10+ Specify what to do if a task misfires. If unspecified, then no action is taken. Note: CF 2018 Enterprise Required; not supported in Standard Edition
CF 10+ Schedule the task time in quartz cron expression format (6 or 7 space-seperated values). Format is: second, minute, hour, day of month, month, day of week, year. Second value is required, as are the rest, but year is optional.
CF 10+ Specify the number of times a given schedule has to repeat.
CF 10+ Specify the number of times to retry the task if the task fails. Must be between 0 and 3, inclusive.
CF 10+ Set the priority of this task.
CF 10+ Comma-separated list of dates or date range on which to not execute the scheduled task.
CF 10+ If yes, the task can be executed in a cluster setup. Note: CF 2018 Enterprise Required; not supported in Standard Edition
CF 10+ Specify whether to overwrite the output files on task execution (if true) or create new output files (if false).
lucee4.5+ If true, the scheduled task is only executed once at time. If a task is still running from previous round no new task is started.
lucee4.5+ If set to true, the scheduled task will be deleted when there is no possible future execution.
lucee4.5+ If true, the scheduled task can not be modified or deleted in the Lucee Administrator.