<cfschedule>

Provides a programmatic interface to the scheduling engine. You can run a specified page at scheduled intervals with the option to write out static HTML pages. This lets you offer users access to pages that publish data, such as reports, without forcing users to wait while a database transaction is performed in order to populate the data on the page.

This tag cannot have a body.

This tag is also supported within <cfscript>

Attribute Description
operation
string, optional

The type of operation the scheduler performs when executing this task.

  • HTTPRequest: make a http(s) request to the url provided
hidden
boolean, optional

if set to true the scheduled task is not displayed in the Lucee Administrator.
requesttimeout
any, optional

Customizes the requestTimeOut for the task operation. Can be used to extend the default timeout for operations that require more time to execute.
proxyuser
string, optional

User name to provide to the proxy server.
serverpassword
string, optional

allow you to access filesystem, also when access is denied for your context
url
string, optional

Required when action = 'update'. The URL to be executed.
password
string, optional

Password if URL is protected.
endtime
any, optional

The time when the scheduled task ends. Enter a value in seconds.
file
string, optional

Required with publish ='Yes' A valid filename for the published file.
result
string, optional

return variable name of action list
username
string, optional

Username if URL is protected.
publish
boolean, optional

Specifies whether the result should be saved to a file.
task
string, optional

The name of the task to delete, update, or run.
starttime
any, optional

Required when creating tasks with action = 'update'. Enter a value in seconds. The time when scheduling of the task starts.
proxyport
any, optional

The port number on the proxy server from which the task is being requested. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.
proxypassword
string, optional

Password to provide to the proxy server.
enddate
any, optional

The date when the scheduled task ends.
interval
string, optional

Required when creating tasks with action = 'update'. Interval at which task should be scheduled. Can be set in seconds or as Once, Daily, Weekly, and Monthly. The default interval is one hour. The minimum interval is one minute.
startdate
any, optional

Required when action ='update'. The date when scheduling of the task should start.
path
string, optional

Required with publish ='Yes' The path location for the published file.
proxyserver
string, optional

Host name or IP address of a proxy server.
paused
boolean, optional

if set to true the scheduled task is paused.
port
any, optional

The port number on the server from which the task is being scheduled. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.
action
string, required
  • 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
  • list: list all scheduled tasks defined
  • pause: pause execution of the defined scheduled task
  • resume: resume execution of a paused scheduled task
readonly
boolean, optional

if set to true the scheduled task can not be modified or deleted in the Lucee Administrator.
autodelete
boolean, optional

if set to true, the scheduled task get deleted when there is no possible future execution.
resolveurl
boolean, optional

Specifies whether to resolve links in the result page to absolute references.

 
<cfschedule
    [operation=string]
    [hidden=boolean]
    [requesttimeout=any]
    [proxyuser=string]
    [serverpassword=string]
    [url=string]
    [password=string]
    [endtime=any]
    [file=string]
    [result=string]
    [username=string]
    [publish=boolean]
    [task=string]
    [starttime=any]
    [proxyport=any]
    [proxypassword=string]
    [enddate=any]
    [interval=string]
    [startdate=any]
    [path=string]
    [proxyserver=string]
    [paused=boolean]
    [port=any]
    action=delete|run|update|list|resume|pause
    [readonly=boolean]
    [autodelete=boolean]
    [resolveurl=boolean]
>

Examples

Syntax for cfschedule

<cfschedule
    action="update"
    task="test"
    operation="HTTPRequest"
    startDate="6/02/2019"
    startTime="12:00 AM"
    url="https://www.test.com/schedule_task/test.cfm"
    interval="daily"
    publish = "Yes"
    file = "myfile.log"
    path = "#expandPath('./')#" />

See also