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.
<cfschedule action="delete" task="">
Attribute Reference for the cfschedule tag
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.
Name of the task.
Operation that the scheduler performs. Must be HTTPRequest.
Name of the file in which to store the published output of
the scheuled task
Path to the directory in which to put the published file.
Date on which to first run the scheuled 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)
Deprecated as of CF 11+ 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
No: does not
The group to which the scheduled task belongs.
If the task is server-specific or application specific.
result (coldfusion)/returnvariable (lucee)
Required: For the list action
Name for the query in which cfschedule returns the result variables.
Examples sample code using the cfschedule tag
Create or update a task
Tell Coldfusion to run 'importData.cfm' daily at 7AM
Delete a scheduled task
Delete the task 'importMyCSVFileToDB' from the list of Coldfusion scheduled jobs